Struct socket2::TcpKeepalive
source · pub struct TcpKeepalive { /* private fields */ }
Expand description
Configures a socket’s TCP keepalive parameters.
Implementations§
source§impl TcpKeepalive
impl TcpKeepalive
sourcepub const fn new() -> TcpKeepalive
pub const fn new() -> TcpKeepalive
Returns a new, empty set of TCP keepalive parameters.
sourcepub const fn with_time(self, time: Duration) -> Self
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.
sourcepub const fn with_interval(self, interval: Duration) -> Self
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.
sourcepub const fn with_retries(self, retries: u32) -> Self
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§
source§impl Clone for TcpKeepalive
impl Clone for TcpKeepalive
source§fn clone(&self) -> TcpKeepalive
fn clone(&self) -> TcpKeepalive
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more