Struct SshConnectionConfig 

pub struct SshConnectionConfig {
    pub connect_timeout_secs: u32,
    pub max_retry_attempts: u32,
    pub retry_interval_secs: u32,
    pub retry_log_frequency: u32,
}

SSH connection behavior configuration

Groups all connection-related parameters (timeouts, retries, logging) separately from authentication credentials and target address.

This type encapsulates connection behavior settings that affect how SSH connections are established and retried, distinct from authentication credentials and the target host address.

Examples

use torrust_tracker_deployer_lib::adapters::ssh::SshConnectionConfig;

// Use default configuration
let config = SshConnectionConfig::default();

// Create custom configuration for fast testing
let fast_config = SshConnectionConfig::new(1, 5, 1, 2);

// Create custom configuration for slow networks
let slow_config = SshConnectionConfig::new(30, 20, 6, 3);

Fields

connect_timeout_secs: u32

SSH connection timeout in seconds

max_retry_attempts: u32

Maximum number of connection retry attempts

retry_interval_secs: u32

Seconds to wait between retry attempts

retry_log_frequency: u32

Log progress every N retry attempts

Implementations

impl SshConnectionConfig

pub fn new( connect_timeout_secs: u32, max_retry_attempts: u32, retry_interval_secs: u32, retry_log_frequency: u32, ) -> Self

Create a new connection configuration with custom values

Arguments

• connect_timeout_secs - SSH connection timeout in seconds
• max_retry_attempts - Maximum number of connection retry attempts
• retry_interval_secs - Seconds to wait between retry attempts
• retry_log_frequency - Log progress every N retry attempts

Examples

use torrust_tracker_deployer_lib::adapters::ssh::SshConnectionConfig;

// Fast configuration for testing
let fast = SshConnectionConfig::new(1, 5, 1, 2);

// Slow configuration for unreliable networks
let slow = SshConnectionConfig::new(30, 20, 6, 3);

pub fn total_timeout_secs(&self) -> u32

Calculate total wait time in seconds (max_retry_attempts × retry_interval_secs)

Returns the maximum time that will be spent waiting for SSH connectivity if all retry attempts are exhausted.

Examples

use torrust_tracker_deployer_lib::adapters::ssh::SshConnectionConfig;

let config = SshConnectionConfig::default();
assert_eq!(config.total_timeout_secs(), 300); // 60 attempts × 5 seconds

Trait Implementations

impl Clone for SshConnectionConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SshConnectionConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SshConnectionConfig

fn default() -> Self

Default connection configuration (production settings)

Uses constants defined at module level:

• Connection timeout: DEFAULT_CONNECT_TIMEOUT_SECS (5 seconds)
• Max retry attempts: DEFAULT_MAX_RETRY_ATTEMPTS (60)
• Retry interval: DEFAULT_RETRY_INTERVAL_SECS (5 seconds)
• Retry log frequency: DEFAULT_RETRY_LOG_FREQUENCY (every 5 attempts)
• Total wait time: 60 × 5 = 300 seconds