]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Fix documentation on PeerHandleError 2021-02-check-close-source
authorMatt Corallo <git@bluematt.me>
Mon, 1 Feb 2021 01:53:28 +0000 (20:53 -0500)
committerMatt Corallo <git@bluematt.me>
Wed, 10 Feb 2021 00:06:00 +0000 (19:06 -0500)
lightning/src/ln/peer_handler.rs

index e083c0119cee82678dd89d803ab3fba1c775c525..742b1ff3a1fffa81de8ec1549746f366bf0eca52 100644 (file)
@@ -88,10 +88,8 @@ pub trait SocketDescriptor : cmp::Eq + hash::Hash + Clone {
 }
 
 /// Error for PeerManager errors. If you get one of these, you must disconnect the socket and
-/// generate no further read_event/write_buffer_space_avail calls for the descriptor, only
-/// triggering a single socket_disconnected call (unless it was provided in response to a
-/// new_*_connection event, in which case no such socket_disconnected() must be called and the
-/// socket silently disconencted).
+/// generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
+/// descriptor.
 pub struct PeerHandleError {
        /// Used to indicate that we probably can't make any future connections to this peer, implying
        /// we should go ahead and force-close any channels we have with it.