Struct socket2::TcpKeepalive

pub struct TcpKeepalive { /* private fields */ }

Configures a socket’s TCP keepalive parameters.

See Socket::set_tcp_keepalive.

Implementations

impl TcpKeepalive

pub const fn new() -> TcpKeepalive

Returns a new, empty set of TCP keepalive parameters.

pub const fn with_time(self, time: Duration) -> Self

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.

pub const fn with_interval(self, interval: Duration) -> Self

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.

pub const fn with_retries(self, retries: u32) -> Self

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.

Trait Implementations

impl Clone for TcpKeepalive

fn clone(&self) -> TcpKeepalive

Returns a copy 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

Formats the value using the given formatter.