Struct paho_mqtt::connect_options::ConnectOptions

pub struct ConnectOptions { /* private fields */ }

The collection of options for connecting to a broker.

This can be constructed using a ConnectOptionsBuilder to set all the options.

Implementations

impl ConnectOptions

pub fn new() -> Self

Creates a new, default set of connect options.

pub fn mqtt_version(&self) -> u32

Gets the MQTT protocol version that should be used for the connection.

pub fn set_mqtt_version(&mut self, ver: u32)

Sets the MQTT protocol version that should be used for the connection.

This also insures that the other options are compatible with the selected version. For example, when setting for v5, it will make sure the cleansession flag is cleared, since v5 uses cleanstart, not cleansession.

pub fn clean_session(&self) -> bool

Gets the “clean session” setting in the options.

This is only used in MQTT v3 connections.

pub fn set_clean_session(&mut self, clean: bool)

This sets the “clean session” behavior for connecting to the server.

When set to true, this directs the server to throw away any state related to the client, as determined by the client identifier. When set to false, the server keeps the state information and resumes the previous session.

This is only used in MQTT v3 connections.

pub fn clean_start(&self) -> bool

Gets the “clean start” setting in the options.

This is only used in MQTT v5 connections.

pub fn set_clean_start(&mut self, clean: bool)

This sets the “clean start” behavior for connecting to the server.

When set to true, this directs the server to throw away any state related to the client, as determined by the client identifier. When set to false, the server keeps the state information and resumes the previous session.

This is only used in MQTT v5 connections.

pub fn set_token(&mut self, tok: ConnectToken)

Sets the token to ber used for connect completion callbacks.

Note that we leak the token to give to the C lib. When we’re done with it, we must recover and drop it (i.e. in the completion callback).

Trait Implementations

impl Clone for ConnectOptions

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectOptions

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

Formats the value using the given formatter.

impl Default for ConnectOptions

fn default() -> Self

Returns the “default value” for a type.

impl Send for ConnectOptions

impl Sync for ConnectOptions