Struct rumqtt::mqttoptions::MqttOptions

pub struct MqttOptions { /* fields omitted */ }

Mqtt options

Methods

impl MqttOptions

pub fn new<S: Into<String>, T: Into<String>>(     id: S,     host: T,     port: u16 ) -> MqttOptions

New mqtt options

pub fn broker_address(&self) -> (String, u16)

Broker address

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(&self) -> Duration

Keep alive time

pub fn client_id(&self) -> String

Client identifier

pub fn set_max_packet_size(self, sz: usize) -> Self

Set packet size limit (in Kilo Bytes)

pub fn max_packet_size(&self) -> usize

Maximum packet size

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_connection_method(self, opts: ConnectionMethod) -> Self

Set how to connect to a MQTT Broker (either TCP or Tls)

pub fn connection_method(&self) -> ConnectionMethod

pub fn set_proxy(self, proxy: Proxy) -> Self

pub fn proxy(&self) -> Proxy

pub fn set_reconnect_opts(self, opts: ReconnectOptions) -> Self

Time interval after which client should retry for new connection if there are any disconnections. By default, no retry will happen

pub fn reconnect_opts(&self) -> ReconnectOptions

Reconnection options

pub fn set_security_opts(self, opts: SecurityOptions) -> Self

Set security option Supports username-password auth, tls client cert auth, gcloud iotcore jwt auth

pub fn security_opts(&self) -> SecurityOptions

Security options

pub fn set_last_will(self, last_will: LastWill) -> Self

Set last will and testament

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

Last will and testament

pub fn set_notification_channel_capacity(self, capacity: usize) -> Self

Set notification channel capacity

pub fn notification_channel_capacity(&self) -> usize

Notification channel capacity

pub fn set_request_channel_capacity(self, capacity: usize) -> Self

Set request channel capacity

pub fn request_channel_capacity(&self) -> usize

Request channel capacity

pub fn set_outgoing_ratelimit(self, rate: u64) -> Self

Enables throttling and sets outoing message rate to the specified 'rate'

pub fn outgoing_ratelimit(&self) -> Option<u64>

Outgoing message rate

pub fn set_outgoing_queuelimit(self, queue_size: usize, delay: Duration) -> Self

Sleeps for the 'delay' about of time before sending the next message if the specified 'queue_size's are hit

pub fn outgoing_queuelimit(&self) -> (usize, Duration)

Outgoing queue limit

Trait Implementations

impl Default for MqttOptions

fn default() -> Self

Returns the "default value" for a type.

impl Clone for MqttOptions

fn clone(&self) -> MqttOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MqttOptions

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

Formats the value using the given formatter.