## TcpKeepalive

# Struct TcpKeepalive

Source

    pub struct TcpKeepalive { /* private fields */ }

Expand description

Configures a socket’s TCP keepalive parameters.

See `Socket::set_tcp_keepalive`.

## Implementations§

Source§

### impl TcpKeepalive

Source

#### pub const fn new() -> TcpKeepalive

Returns a new, empty set of TCP keepalive parameters.

Source

#### 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.

Source

#### 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.

Source

#### 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

Source§

#### fn clone(&self) -> TcpKeepalive

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for TcpKeepalive

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl Freeze for TcpKeepalive

§

### impl RefUnwindSafe for TcpKeepalive

§

### impl Send for TcpKeepalive

§

### impl Sync for TcpKeepalive

§

### impl Unpin for TcpKeepalive

§

### impl UnwindSafe for TcpKeepalive

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.