Struct Config

pub struct Config {
    pub client_id: SshId,
    pub limits: Limits,
    pub window_size: u32,
    pub maximum_packet_size: u32,
    pub channel_buffer_size: usize,
    pub preferred: Preferred,
    pub inactivity_timeout: Option<Duration>,
    pub keepalive_interval: Option<Duration>,
    pub keepalive_max: usize,
    pub anonymous: bool,
    pub gex: GexParams,
}

The configuration of clients.

Fields

client_id: SshId

The client ID string sent at the beginning of the protocol.

limits: Limits

The bytes and time limits before key re-exchange.

window_size: u32

The initial size of a channel (used for flow control).

maximum_packet_size: u32

The maximal size of a single packet.

channel_buffer_size: usize

Buffer size for each channel (a number of unprocessed messages to store before propagating backpressure to the TCP stream)

preferred: Preferred

Lists of preferred algorithms.

inactivity_timeout: Option<Duration>

Time after which the connection is garbage-collected.

keepalive_interval: Option<Duration>

If nothing is received from the server for this amount of time, send a keepalive message.

keepalive_max: usize

If this many keepalives have been sent without reply, close the connection.

anonymous: bool

Whether to expect and wait for an authentication call.

gex: GexParams

DH dynamic group exchange parameters.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.