Struct socket2::TcpKeepalive
source · [−]pub struct TcpKeepalive { /* private fields */ }
Expand description
Configures a socket’s TCP keepalive parameters.
Implementations
sourceimpl 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
sourceimpl Clone for TcpKeepalive
impl Clone for TcpKeepalive
sourcefn clone(&self) -> TcpKeepalive
fn clone(&self) -> TcpKeepalive
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for TcpKeepalive
impl Send for TcpKeepalive
impl Sync for TcpKeepalive
impl Unpin for TcpKeepalive
impl UnwindSafe for TcpKeepalive
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more