Enum mqtt_async_client::client::KeepAlive

pub enum KeepAlive {
    Disabled,
    Enabled {
        secs: u16,
    },
}

Represents the keep alive setting for a client.

Variants

Disabled

Keep alive ping packets are disabled.

Enabled

Send a keep alive ping packet every secs seconds.

Fields of Enabled

secs: u16

The number of seconds between packets.

Methods

impl KeepAlive

pub fn from_secs(secs: u16) -> KeepAlive

Set keep alive time in seconds.

Panics if secs parameter is 0.

pub fn disabled() -> KeepAlive

Disable keep alive functionality.

pub fn is_enabled(&self) -> bool

Returns whether keep alives are enabled.

pub fn is_disabled(&self) -> bool

Returns whether keep alives are disabled.

pub fn as_duration(&self) -> Option<Duration>

Returns the keep alive interval if enabled as Some(tokio::Duration), or None if disabled.

Trait Implementations

impl Clone for KeepAlive

fn clone(&self) -> KeepAlive

Returns a copy of the value.

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.