Struct TcpKeepaliveParams

pub struct TcpKeepaliveParams {
    pub timeout_ms: Option<u32>,
    pub count: Option<u32>,
    pub interval_ms: Option<u32>,
}

Value of --tcp-keepalive option.

When parsed from string, it expects 0 to 3 colon-separated numbers:

• Timeout (in milliseconds)
• Number of failed pings before failing the connection
• Interval of pings (in milliseconds)

Specifying empty string or “” just requests to enable keepalives without configuring parameters.

On unsupported platforms, all or some details of keepalives may be ignored.

Example:

use tokio_listener::TcpKeepaliveParams;
let k1 : TcpKeepaliveParams = "60000:3:5000".parse().unwrap();
let k2 : TcpKeepaliveParams = "60000".parse().unwrap();
let k3 : TcpKeepaliveParams = "".parse().unwrap();

assert_eq!(k1, TcpKeepaliveParams{timeout_ms:Some(60000), count:Some(3), interval_ms:Some(5000)});

Fields

timeout_ms: Option<u32>

Amount of time after which TCP keepalive probes will be sent on idle connections.

count: Option<u32>

Maximum number of TCP keepalive probes that will be sent before dropping a connection.

interval_ms: Option<u32>

Time interval between TCP keepalive probes.

Implementations

impl TcpKeepaliveParams

pub fn to_socket2(&self) -> TcpKeepalive

Attempt to convert values of this struct to socket2 format.

Some fields may be ignored depending on platform.

Trait Implementations

impl Clone for TcpKeepaliveParams

fn clone(&self) -> TcpKeepaliveParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TcpKeepaliveParams

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

Formats the value using the given formatter.

impl Default for TcpKeepaliveParams

fn default() -> TcpKeepaliveParams

Returns the “default value” for a type.

impl Display for TcpKeepaliveParams

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

Formats the value using the given formatter.

impl FromStr for TcpKeepaliveParams

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(input_string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for TcpKeepaliveParams

fn eq(&self, other: &TcpKeepaliveParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TcpKeepaliveParams

impl Eq for TcpKeepaliveParams

impl StructuralPartialEq for TcpKeepaliveParams