Struct MqttConnectionSettings

pub struct MqttConnectionSettings { /* private fields */ }

All the settings required to establish an MQTT connection.

Implementations

impl MqttConnectionSettings

Auto-generated by derive_getters::Getters.

pub fn client_id(&self) -> &String

Client identifier

pub fn hostname(&self) -> &String

FQDN of the host to connect to

pub fn tcp_port(&self) -> u16

TCP port to connect to the host on

pub fn keep_alive(&self) -> &Duration

Max time between communications

pub fn receive_max(&self) -> u16

Max number of in-flight Quality of Service 1 and 2 messages

pub fn receive_packet_size_max(&self) -> &Option<u32>

Max size of a received packet

pub fn session_expiry(&self) -> &Duration

Session Expiry Interval

pub fn connection_timeout(&self) -> &Duration

Connection timeout

pub fn clean_start(&self) -> bool

Clean start

pub fn username(&self) -> &Option<String>

Username for MQTT

pub fn password(&self) -> &Option<String>

Password for MQTT

pub fn password_file(&self) -> &Option<String>

Path to a file containing the MQTT password

pub fn use_tls(&self) -> bool

TLS negotiation enabled

pub fn ca_file(&self) -> &Option<String>

Path to a PEM file used to validate server identity

pub fn cert_file(&self) -> &Option<String>

Path to PEM file used to establish X509 client authentication

pub fn key_file(&self) -> &Option<String>

Path to a file containing a key used to establish X509 client authentication

pub fn key_password_file(&self) -> &Option<String>

Path to a file containing the password used to decrypt the Key

pub fn sat_file(&self) -> &Option<String>

Path to a SAT file to be used for SAT auth

Trait Implementations

impl Clone for MqttConnectionSettings

fn clone(&self) -> MqttConnectionSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MqttConnectionSettings

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

Formats the value using the given formatter.

impl TryFrom<MqttConnectionSettings> for MqttOptions

type Error = ConnectionSettingsAdapterError

The type returned in the event of a conversion error.

fn try_from(value: MqttConnectionSettings) -> Result<Self, Self::Error>

Performs the conversion.