# Struct mio::net::TcpKeepalive [−] [src]

    pub struct TcpKeepalive { /* fields omitted */ }

Configures a socket’s TCP keepalive parameters.

## Implementations

### `impl TcpKeepalive` [src]

#### `pub fn with_time(self, time: Duration) -> Self` [src]

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` [src]

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` [src]

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` [src]

Returns a new, empty set of TCP keepalive parameters.

## Trait Implementations

### `impl Clone for TcpKeepalive` [src]

#### `fn clone(&self) -> TcpKeepalive` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Debug for TcpKeepalive` [src]

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

Formats the value using the given formatter. Read more

### `impl Default for TcpKeepalive` [src]

#### `fn default() -> TcpKeepalive` [src]

Returns the “default value” for a type. 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

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

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

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.