Struct TcpKeepAlive 

pub struct TcpKeepAlive {
    pub time: Option<Duration>,
    pub interval: Option<Duration>,
    pub retries: Option<u32>,
}

Configures a Socket’s TCP keepalive parameters.

See SocketOptions::tcp_keep_alive.

Fields

time: Option<Duration>

Set the amount of time after which TCP keepalive probes will be sent on idle connections.

This will set TCP_KEEPALIVE on macOS and iOS, and TCP_KEEPIDLE on all other Unix operating systems, except OpenBSD and Haiku which don’t support any way to set this option. On Windows, this sets the value of the tcp_keepalive struct’s keepalivetime field.

Some platforms specify this value in seconds, so sub-second specifications may be omitted.

interval: Option<Duration>

Set the value of the TCP_KEEPINTVL option. On Windows, this sets the value of the tcp_keepalive struct’s keepaliveinterval field.

Sets the time interval between TCP keepalive probes.

Some platforms specify this value in seconds, so sub-second specifications may be omitted.

retries: Option<u32>

Set the value of the TCP_KEEPCNT option.

Set the maximum number of TCP keepalive probes that will be sent before dropping a connection, if TCP keepalive is enabled on this Socket.

Implementations

impl TcpKeepAlive

pub fn into_socket_keep_alive(self) -> TcpKeepalive

Trait Implementations

impl Clone for TcpKeepAlive

fn clone(&self) -> TcpKeepAlive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TcpKeepAlive

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

Formats the value using the given formatter.

impl Default for TcpKeepAlive

fn default() -> TcpKeepAlive

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TcpKeepAlive

fn deserialize<D>( deserializer: D, ) -> Result<TcpKeepAlive, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TcpKeepAlive> for TcpKeepalive

fn from(value: TcpKeepAlive) -> TcpKeepalive

Converts to this type from the input type.

impl Serialize for TcpKeepAlive

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.