fixed #141 - renamed Config::connection_timeout to Config::inactivity_timeout

Author: Eugeny

russh/examples/echoserver.rs

@@ -14,7 +14,7 @@ async fn main() {
         .init();
 
     let config = russh::server::Config {
-        connection_timeout: Some(std::time::Duration::from_secs(3600)),
+        inactivity_timeout: Some(std::time::Duration::from_secs(3600)),
         auth_rejection_time: std::time::Duration::from_secs(3),
         auth_rejection_time_initial: Some(std::time::Duration::from_secs(0)),
         keys: vec![russh_keys::key::KeyPair::generate_ed25519().unwrap()],

russh/examples/remote_shell_call.rs

@@ -62,7 +62,7 @@ impl Session {
     ) -> Result<Self> {
         let key_pair = load_secret_key(key_path, None)?;
         let config = client::Config {
-            connection_timeout: Some(Duration::from_secs(5)),
+            inactivity_timeout: Some(Duration::from_secs(5)),
             ..<_>::default()
         };
         let config = Arc::new(config);

russh/examples/sftp_server.rs

@@ -185,7 +185,7 @@ async fn main() {
         auth_rejection_time: Duration::from_secs(3),
         auth_rejection_time_initial: Some(Duration::from_secs(0)),
         keys: vec![KeyPair::generate_ed25519().unwrap()],
-        connection_timeout: Some(Duration::from_secs(3600)),
+        inactivity_timeout: Some(Duration::from_secs(3600)),
         ..Default::default()
     };
 

russh/src/client/mod.rs

@@ -1240,7 +1240,7 @@ pub struct Config {
     /// Lists of preferred algorithms.
     pub preferred: negotiation::Preferred,
     /// Time after which the connection is garbage-collected.
-    pub connection_timeout: Option<std::time::Duration>,
+    pub inactivity_timeout: Option<std::time::Duration>,
     /// Whether to expect and wait for an authentication call.
     pub anonymous: bool,
 }
@@ -1257,7 +1257,7 @@ impl Default for Config {
             window_size: 2097152,
             maximum_packet_size: 32768,
             preferred: Default::default(),
-            connection_timeout: None,
+            inactivity_timeout: None,
             anonymous: false,
         }
     }

russh/src/lib.rs

@@ -485,7 +485,7 @@ mod test_compress {
         let client_key = russh_keys::key::KeyPair::generate_ed25519().unwrap();
         let mut config = server::Config::default();
         config.preferred = Preferred::COMPRESSED;
-        config.connection_timeout = None; // Some(std::time::Duration::from_secs(3));
+        config.inactivity_timeout = None; // Some(std::time::Duration::from_secs(3));
         config.auth_rejection_time = std::time::Duration::from_secs(3);
         config
             .keys
@@ -623,7 +623,7 @@ async fn test_session<RC, RS, CH, SH, F1, F2>(
 
     let client_key = russh_keys::key::KeyPair::generate_ed25519().unwrap();
     let mut config = server::Config::default();
-    config.connection_timeout = None;
+    config.inactivity_timeout = None;
     config.auth_rejection_time = std::time::Duration::from_secs(3);
     config
         .keys
@@ -637,7 +637,7 @@ async fn test_session<RC, RS, CH, SH, F1, F2>(
 
     let server_join = tokio::spawn(async move {
         let (socket, _) = socket.accept().await.unwrap();
-        
+
         server::run_stream(config, socket, server_handler)
             .await
             .map_err(|_| ())

russh/src/server/mod.rs

@@ -39,7 +39,7 @@
 //!     let client_key = russh_keys::key::KeyPair::generate_ed25519().unwrap();
 //!     let client_pubkey = Arc::new(client_key.clone_public_key().unwrap());
 //!     let mut config = russh::server::Config::default();
-//!     config.connection_timeout = Some(std::time::Duration::from_secs(3));
+//!     config.inactivity_timeout = Some(std::time::Duration::from_secs(3));
 //!     config.auth_rejection_time = std::time::Duration::from_secs(3);
 //!     config.keys.push(russh_keys::key::KeyPair::generate_ed25519().unwrap());
 //!     let config = Arc::new(config);
@@ -167,7 +167,7 @@ pub struct Config {
     /// Maximal number of allowed authentication attempts.
     pub max_auth_attempts: usize,
     /// Time after which the connection is garbage-collected.
-    pub connection_timeout: Option<std::time::Duration>,
+    pub inactivity_timeout: Option<std::time::Duration>,
 }
 
 impl Default for Config {
@@ -189,7 +189,7 @@ impl Default for Config {
             limits: Limits::default(),
             preferred: Default::default(),
             max_auth_attempts: 10,
-            connection_timeout: Some(std::time::Duration::from_secs(600)),
+            inactivity_timeout: Some(std::time::Duration::from_secs(600)),
         }
     }
 }
@@ -724,7 +724,7 @@ async fn read_ssh_id<R: AsyncRead + Unpin>(
     config: Arc<Config>,
     read: &mut SshRead<R>,
 ) -> Result<CommonSession<Arc<Config>>, Error> {
-    let sshid = if let Some(t) = config.connection_timeout {
+    let sshid = if let Some(t) = config.inactivity_timeout {
         tokio::time::timeout(t, read.read_ssh_id()).await??
     } else {
         read.read_ssh_id().await?

russh/src/server/session.rs

@@ -333,7 +333,7 @@ impl Session {
         pin!(reading);
         let mut is_reading = None;
         let mut decomp = CryptoVec::new();
-        let delay = self.common.config.connection_timeout;
+        let delay = self.common.config.inactivity_timeout;
 
         #[allow(clippy::panic)] // false positive in macro
         while !self.common.disconnected {