aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2020-12-14 11:41:25 +0100
committerAlex Auvolat <alex@adnab.me>2020-12-14 11:41:25 +0100
commit9e38b82edcba5f60eb0ed95b5551947c0c03ba3c (patch)
tree247bfbd7aa82a56a6af67b072184a822eb9b9424
parent5d07711900b84dc8095fba5eea3b1ab4925145db (diff)
downloadnetapp-9e38b82edcba5f60eb0ed95b5551947c0c03ba3c.tar.gz
netapp-9e38b82edcba5f60eb0ed95b5551947c0c03ba3c.zip
Update documentation
-rw-r--r--src/lib.rs2
-rw-r--r--src/netapp.rs2
2 files changed, 3 insertions, 1 deletions
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<M, F, R>(&self, handler: F)
where
M: Message + 'static,