From 9e38b82edcba5f60eb0ed95b5551947c0c03ba3c Mon Sep 17 00:00:00 2001 From: Alex Auvolat Date: Mon, 14 Dec 2020 11:41:25 +0100 Subject: Update documentation --- src/lib.rs | 2 +- src/netapp.rs | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/src/lib.rs b/src/lib.rs index 6987b54..a0bec32 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -6,7 +6,7 @@ //! - peer discovery //! - query/response message passing model for communications //! - multiplexing transfers over a connection -//! - overlay networks: full mesh or random peer sampling using Basalt +//! - overlay networks: full mesh, and soon other methods //! //! Of particular interest, read the documentation for the `netapp::NetApp` type, //! the `message::Message` trait, and `proto::RequestPriority` to learn more diff --git a/src/netapp.rs b/src/netapp.rs index 9733fb7..eed0f59 100644 --- a/src/netapp.rs +++ b/src/netapp.rs @@ -158,6 +158,8 @@ impl NetApp { /// Add a handler for a certain message type. Note that only one handler /// can be specified for each message type. + /// The handler is an asynchronous function, i.e. a function that returns + /// a future. pub fn add_msg_handler(&self, handler: F) where M: Message + 'static, -- cgit v1.2.3