Update crates/net/network-api/src/lib.rs

Co-authored-by: Emilia Hane <emiliaha95@gmail.com>
paradigmxyz · Aug 3, 2024 · 571fa15 · 571fa15
1 parent 34f19b1
commit 571fa15
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/crates/net/network-api/src/lib.rs b/crates/net/network-api/src/lib.rs
@@ -148,7 +148,8 @@ pub trait Peers: PeersInfo {
     /// Disconnect an existing connection to the given peer using the provided reason
     fn disconnect_peer_with_reason(&self, peer: PeerId, reason: DisconnectReason);
 
-    /// reconnect a connection to the given peer
+    /// Connect to the given peer. NOTE: if the maximum number out outbound sessions is reached, 
+    /// this won't do anything. See `reth_network::SessionManager::dial_outbound`.
     fn reconnect_peer(&self, addr: SocketAddr, peer: PeerId);
 
     /// Send a reputation change for the given peer.