Skip to content

Commit 8e4b370

Browse files
ramfox“ramfox”
authored andcommitted
docs: fix doc comment for magic_endpoint_conn_type_cb
1 parent c6b79c3 commit 8e4b370

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

src/endpoint.rs

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -743,12 +743,9 @@ impl From<iroh::endpoint::ConnectionType> for ConnectionType {
743743
}
744744
}
745745

746-
/// Run a callback once you have a direct connection to a peer
746+
/// Run a callback each time the [`ConnectionType`] to that peer has changed.
747747
///
748-
/// Does not block. The provided callback will be called when we have a direct
749-
/// connection to the peer associated with the `node_id`, or the timeout has occurred.
750-
///
751-
/// To wait indefinitely, provide -1 for the timeout parameter.
748+
/// Does not block. This will run until the connection has closed.
752749
///
753750
/// `ctx` is passed along to the callback, to allow passing context, it must be thread safe as the callback is
754751
/// called from another thread.

0 commit comments

Comments
 (0)