Struct mqttrust_core::MqttOptions

pub struct MqttOptions<'a> { /* fields omitted */ }

Options to configure the behaviour of mqtt connection

Lifetimes:

• ’a: The lifetime of option fields, not referenced in any MQTT packets at any point
• ’b: The lifetime of the packet fields, backed by a slice buffer

Implementations

impl<'a> MqttOptions<'a>

pub fn new(id: &'a str, broker: Broker<'a>, port: u16) -> MqttOptions<'a>

New mqtt options

pub fn broker(&self) -> (Broker<'_>, u16)

Broker address

pub fn set_last_will(self, will: LastWill<'a>) -> Self

pub fn last_will(&self) -> Option<LastWill<'a>>

pub fn set_ca(self, ca: &'a [u8]) -> Self

pub fn ca(&self) -> Option<&[u8]>

pub fn set_client_auth(
    self,
    cert: &'a [u8],
    key: &'a [u8],
    password: Option<&'a [u8]>
) -> Self

pub fn client_auth(&self) -> Option<(&'a [u8], &'a [u8], Option<&'a [u8]>)>

pub fn set_keep_alive(self, secs: u16) -> Self

Set number of seconds after which client should ping the broker if there is no other data exchange

pub fn keep_alive_ms(&self) -> u32

Keep alive time

pub fn client_id(&self) -> &'a str

Client identifier

pub fn set_clean_session(self, clean_session: bool) -> Self

clean_session = true removes all the state from queues & instructs the broker to clean all the client state when client disconnects.

When set false, broker will hold the client state and performs pending operations on the client when reconnection with same client_id happens. Local queue state is also held to retransmit packets after reconnection.

pub fn clean_session(&self) -> bool

Clean session

pub fn set_credentials(self, username: &'a str, password: &'a [u8]) -> Self

Username and password

pub fn credentials(&self) -> (Option<&'a str>, Option<&'a [u8]>)

Security options

pub fn set_inflight(self, inflight: usize) -> Self

Set number of concurrent in flight messages

pub fn inflight(&self) -> usize

Number of concurrent in flight messages

Trait Implementations

impl<'a> Clone for MqttOptions<'a>

fn clone(&self) -> MqttOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for MqttOptions<'a>

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

Formats the value using the given formatter.