Struct TcpOptions

#[non_exhaustive]
pub struct TcpOptions {
    pub keepalive_idle: Option<Duration>,
    pub keepalive_interval: Option<Duration>,
    pub keepalive_count: Option<u32>,
}

A container of TCP settings to be applied to the sockets created by the hyper client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

keepalive_idle: Option<Duration>

This sets TCP_KEEPIDLE and SO_KEEPALIVE.

keepalive_interval: Option<Duration>

This sets TCP_KEEPINTVL and SO_KEEPALIVE.

keepalive_count: Option<u32>

This sets TCP_KEEPCNT and SO_KEEPALIVE.

Implementations

impl TcpOptions

pub fn keepalive_timeout(dur: Duration) -> Self

keepalive_timeout returns a TCP keepalive policy that times out after the specified duration. The keepalive policy returned waits for half of the supplied duration before sending keepalive packets, and attempts to keep the connection alive three times for the remaining period.

If the supplied duration does not contain at least one whole second, no TCP keepalive policy is returned.

Trait Implementations

impl Clone for TcpOptions

fn clone(&self) -> TcpOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TcpOptions

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

Formats the value using the given formatter.

impl Default for TcpOptions

fn default() -> TcpOptions

Returns the “default value” for a type.

impl PartialEq for TcpOptions

fn eq(&self, other: &TcpOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TcpOptions

impl Eq for TcpOptions

impl StructuralPartialEq for TcpOptions