feat(kad): configurable outbound_substreams timeout

Author: maqi

protocols/kad/CHANGELOG.md

@@ -15,7 +15,9 @@
 - Remove deprecated default constructor for `ProtocolConfig`.
   See [PR 5774](https://github.com/libp2p/rust-libp2p/pull/5774).
 - Add lazy cleanup for expired provider records in `Behavior::get_providers` and `Behavior::provider_peers`.
-  See [PR 5980](https://github.com/libp2p/rust-libp2p/pull/5980)
+  See [PR 5980](https://github.com/libp2p/rust-libp2p/pull/5980).
+- Configurable outbound_substreams_timeout.
+  See [PR 6015](https://github.com/libp2p/rust-libp2p/pull/6015)
 
 <!-- Update to libp2p-core v0.43.0 -->
 

protocols/kad/src/handler.rs

@@ -454,6 +454,8 @@ impl Handler {
             }
         }
 
+        let outbound_substreams_timeout = Duration::from_secs(protocol_config.outbound_substreams_timeout_s());
+
         Handler {
             protocol_config,
             mode,
@@ -462,7 +464,7 @@ impl Handler {
             next_connec_unique_id: UniqueConnecId(0),
             inbound_substreams: Default::default(),
             outbound_substreams: futures_bounded::FuturesTupleSet::new(
-                Duration::from_secs(10),
+                outbound_substreams_timeout,
                 MAX_NUM_STREAMS,
             ),
             pending_streams: Default::default(),

protocols/kad/src/protocol.rs

@@ -49,6 +49,8 @@ use crate::{
 pub(crate) const DEFAULT_PROTO_NAME: StreamProtocol = StreamProtocol::new("/ipfs/kad/1.0.0");
 /// The default maximum size for a varint length-delimited packet.
 pub(crate) const DEFAULT_MAX_PACKET_SIZE: usize = 16 * 1024;
+/// The default timeout of outbound_substreams to be 10 (seconds).
+const DEFAULT_OUTBOUND_SUBSTREAMS_TIMEOUT_S: u64 = 10;
 /// Status of our connection to a node reported by the Kademlia protocol.
 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]
 pub enum ConnectionType {
@@ -145,6 +147,8 @@ pub struct ProtocolConfig {
     protocol_names: Vec<StreamProtocol>,
     /// Maximum allowed size of a packet.
     max_packet_size: usize,
+    /// Specifies the outbound_substreams timeout in seconds
+    outbound_substreams_timeout_s: u64,
 }
 
 impl ProtocolConfig {
@@ -153,6 +157,7 @@ impl ProtocolConfig {
         ProtocolConfig {
             protocol_names: vec![protocol_name],
             max_packet_size: DEFAULT_MAX_PACKET_SIZE,
+            outbound_substreams_timeout_s: DEFAULT_OUTBOUND_SUBSTREAMS_TIMEOUT_S,
         }
     }
 
@@ -165,6 +170,16 @@ impl ProtocolConfig {
     pub fn set_max_packet_size(&mut self, size: usize) {
         self.max_packet_size = size;
     }
+
+    /// Modifies outbount_substreams timeout.
+    pub fn set_outbound_substreams_timeout(&mut self, value: u64) {
+        self.outbound_substreams_timeout_s = value;
+    }
+
+    /// Getter of outbount_substreams_timeout_s.
+    pub fn outbound_substreams_timeout_s(&self) -> u64 {
+        self.outbound_substreams_timeout_s
+    }
 }
 
 impl UpgradeInfo for ProtocolConfig {