Struct mio::net::TcpKeepalive

pub struct TcpKeepalive { /* fields omitted */ }

Configures a socket's TCP keepalive parameters.

Implementations

impl TcpKeepalive

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

on idle connections.

This will set the value of SO_KEEPALIVE + IPPROTO_TCP on OpenBSD, NetBSD, and Haiku, TCP_KEEPALIVE on macOS and iOS, and TCP_KEEPIDLE on all other Unix operating systems. 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 fn with_interval(self, interval: Duration) -> Self

Sets the time interval between TCP keepalive probes. This sets the value of TCP_KEEPINTVL on supported Unix operating systems. On Windows, this sets the value of the tcp_keepalive struct's keepaliveinterval field.

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

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

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

This will set the value of TCP_KEEPCNT on Unix operating systems that support this option.

pub fn new() -> Self

Returns a new, empty set of TCP keepalive parameters.

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.

impl Default for TcpKeepalive

fn default() -> TcpKeepalive

Returns the "default value" for a type.