Enum nng::options::transport::tcp::KeepAlive

pub enum KeepAlive {}

Enable the sending of keep-alive messages on the underlying TCP stream.

This option is false by default. When enabled, if no messages are seen for a period of time, then a zero length TCP message is sent with the ACK flag set in an attempt to tickle some traffic from the peer. If none is still seen (after some platform-specific number of retries and timeouts), then the remote peer is presumed dead, and the connection is closed.

This option has two purposes. First, it can be used to detect dead peers on an otherwise quiescent network. Second, it can be used to keep connection table entries in NAT and other middleware from being expiring due to lack of activity.

Support

• Dialers and Listeners can use this option with the following transports:
  • TCP
  • TLS
• Pipes can read this value on the following transports:
  • TCP
  • TLS
• Sockets can use this to set a default value.

Trait Implementations

impl Clone for KeepAlive

fn clone(&self) -> KeepAlive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for KeepAlive

impl Debug for KeepAlive

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

Formats the value using the given formatter.

impl Display for KeepAlive

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

Formats the value using the given formatter.

impl Eq for KeepAlive

impl GetOpt<KeepAlive> for Dialer

impl GetOpt<KeepAlive> for DialerBuilder

impl GetOpt<KeepAlive> for Listener

impl GetOpt<KeepAlive> for ListenerBuilder

impl GetOpt<KeepAlive> for Pipe

impl Hash for KeepAlive

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Opt for KeepAlive

type OptType = bool

The type that the option read and writes.

impl Ord for KeepAlive

fn cmp(&self, other: &KeepAlive) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<KeepAlive> for KeepAlive

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialOrd<KeepAlive> for KeepAlive

fn partial_cmp(&self, other: &KeepAlive) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SetOpt<KeepAlive> for DialerBuilder

impl SetOpt<KeepAlive> for ListenerBuilder

impl SetOpt<KeepAlive> for Socket

impl StructuralEq for KeepAlive

impl StructuralPartialEq for KeepAlive