Merge branch 'master' into chore/link-workspace-version-edition

Author: dariusc93

libp2p/src/tutorials/ping.rs

@@ -205,12 +205,12 @@
 //! ## Idle connection timeout
 //!
 //! Now, for this example in particular, we need set the idle connection timeout.
-//! Otherwise, the connection will be closed immediately.
+//! The default connection timeout is 10 seconds.
 //!
 //! Whether you need to set this in your application too depends on your usecase.
 //! Typically, connections are kept alive if they are "in use" by a certain protocol.
 //! The ping protocol however is only an "auxiliary" kind of protocol.
-//! Thus, without any other behaviour in place, we would not be able to observe the pings.
+//! Thus, without any other behaviour in place, we would not be able to observe any pings after 10s.
 //!
 //! ```rust
 //! use std::{error::Error, time::Duration};
@@ -232,6 +232,9 @@
 //!             yamux::Config::default,
 //!         )?
 //!         .with_behaviour(|_| ping::Behaviour::default())?
+//!         .with_swarm_config(|cfg| {
+//!             cfg.with_idle_connection_timeout(Duration::from_secs(u64::MAX))
+//!         }) // Allows us to observe pings indefinitely.
 //!         .build();
 //!
 //!     Ok(())
@@ -284,6 +287,9 @@
 //!             yamux::Config::default,
 //!         )?
 //!         .with_behaviour(|_| ping::Behaviour::default())?
+//!         .with_swarm_config(|cfg| {
+//!             cfg.with_idle_connection_timeout(Duration::from_secs(u64::MAX))
+//!         }) // Allows us to observe pings indefinitely.
 //!         .build();
 //!
 //!     // Tell the swarm to listen on all interfaces and a random, OS-assigned
@@ -329,6 +335,9 @@
 //!             yamux::Config::default,
 //!         )?
 //!         .with_behaviour(|_| ping::Behaviour::default())?
+//!         .with_swarm_config(|cfg| {
+//!             cfg.with_idle_connection_timeout(Duration::from_secs(u64::MAX))
+//!         }) // Allows us to observe pings indefinitely.
 //!         .build();
 //!
 //!     // Tell the swarm to listen on all interfaces and a random, OS-assigned