Merge pull request #1626 from TheBlueMatt/2022-07-fix-pm-docs

Remove scary disconenct warnings on PeerManager new connection fns
This commit is contained in:
Matt Corallo 2022-07-25 21:56:40 +00:00 committed by GitHub
commit 79b55f0815
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -622,8 +622,7 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
/// peer using the init message. /// peer using the init message.
/// The user should pass the remote network address of the host they are connected to. /// The user should pass the remote network address of the host they are connected to.
/// ///
/// Note that if an Err is returned here you MUST NOT call socket_disconnected for the new /// If an `Err` is returned here you must disconnect the connection immediately.
/// descriptor but must disconnect the connection immediately.
/// ///
/// Returns a small number of bytes to send to the remote node (currently always 50). /// Returns a small number of bytes to send to the remote node (currently always 50).
/// ///
@ -671,9 +670,8 @@ impl<Descriptor: SocketDescriptor, CM: Deref, RM: Deref, L: Deref, CMH: Deref> P
/// The user should pass the remote network address of the host they are connected to. /// The user should pass the remote network address of the host they are connected to.
/// ///
/// May refuse the connection by returning an Err, but will never write bytes to the remote end /// May refuse the connection by returning an Err, but will never write bytes to the remote end
/// (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT /// (outbound connector always speaks first). If an `Err` is returned here you must disconnect
/// call socket_disconnected for the new descriptor but must disconnect the connection /// the connection immediately.
/// immediately.
/// ///
/// Panics if descriptor is duplicative with some other descriptor which has not yet been /// Panics if descriptor is duplicative with some other descriptor which has not yet been
/// [`socket_disconnected()`]. /// [`socket_disconnected()`].