comments

Author: andrewjstone

trust-quorum/protocol/src/node.rs

@@ -381,6 +381,16 @@ impl Node {
     }
 
     /// A peer node has disconnected from this one
+    ///
+    /// Note: It is safe if a call to `on_disconnect` is missed due to a new
+    /// connection replacing the existing connection and resulting in a call
+    /// to `on_connect` while the node thinks it still maintains a connection.
+    ///
+    /// All active behavior such as retries occur in `on_connect`. If the
+    /// contents of this method change such that it is no longer safe to call
+    /// `on_connect` without first calling `on_disconnect` for an already
+    /// connected peer, then we can call `on_disconnect` first from directly
+    /// within `on_connect`. For now that is unnecessary.
     pub fn on_disconnect(
         &mut self,
         ctx: &mut impl NodeHandlerCtx,

trust-quorum/src/connection_manager.rs

@@ -62,7 +62,7 @@ pub enum MainToConnMsg {
 /// `Node::on_disconnect`.
 ///
 /// By always returning the `task_id`, we allow cleanup of proxy requests for
-/// stale nodes that will never complete.
+/// stale connections that will never complete.
 pub struct DisconnectedPeer {
     pub task_id: task::Id,
     pub peer_id: Option<BaseboardId>,