Struct ConnectOptions 

pub struct ConnectOptions {

    pub host: String,
    pub port: u16,
    pub client_id: String,
    pub version: MqttVersion,
    pub clean_start: bool,
    pub keep_alive_secs: u16,
    pub username: Option<String>,
    pub password: Option<Vec<u8>>,
    pub will: Option<WillOptions>,
    pub connect_timeout_secs: u32,
    pub operation_timeout_secs: u32,
    pub auto_reconnect: bool,
    pub reconnect_backoff_secs: u32,
    pub reconnect_max_backoff_secs: u32,
    pub tls: Option<TlsOptions>,
    pub max_packet_size: u32,
    pub auth_method: Option<String>,
    pub auth_data: Option<Vec<u8>>,
}

Everything needed to establish an MQTT connection.

Fields

host: String

port: u16

client_id: String

version: MqttVersion

Which protocol version to speak. The broker never up/downgrades a connection once CONNECT is sent.

clean_start: bool

MQTT 3.1.1 “Clean Session” / MQTT 5.0 “Clean Start”.

keep_alive_secs: u16

Keep-alive interval in seconds. 0 disables keep-alive pings.

username: Option<String>

password: Option<Vec<u8>>

will: Option<WillOptions>

connect_timeout_secs: u32

Seconds to wait for the TCP connection + CONNACK before failing.

operation_timeout_secs: u32

Seconds to wait for a QoS 1/2 handshake step per attempt before retrying (with DUP=1) — MqttClient::publish retries an unacked QoS 1/2 PUBLISH (or QoS 2’s PUBREL) up to 3 times before giving up, so the worst-case total wait for a single publish() call is up to 4x this value. 0 selects the built-in default (15s).

auto_reconnect: bool

If true, crate::client::MqttClient automatically reconnects (with exponential backoff, see Self::reconnect_backoff_secs / Self::reconnect_max_backoff_secs) after a connection loss that wasn’t caused by calling disconnect(), replaying every topic this client is currently subscribed to (per its own bookkeeping) once reconnected. Off by default — the caller must opt in.

reconnect_backoff_secs: u32

Initial delay before the first reconnect attempt, doubling after each failed attempt up to Self::reconnect_max_backoff_secs. 0 selects the built-in default (1s). Ignored unless Self::auto_reconnect is set.

reconnect_max_backoff_secs: u32

Cap on the exponential reconnect backoff delay. 0 selects the built-in default (30s). Ignored unless Self::auto_reconnect is set.

tls: Option<TlsOptions>

If set, connect over TLS (mqtts) instead of plain TCP. None (the default) is plain TCP, unchanged from before TLS support existed.

max_packet_size: u32

Largest packet (fixed header + body, in bytes) this client will accept from the broker; a larger one is treated as a protocol error and drops the connection instead of being buffered. 0 selects the built-in default (the MQTT protocol maximum, ~256 MiB).

auth_method: Option<String>

MQTT 5.0 enhanced authentication (SCRAM, Kerberos, OAuth, …): the Authentication Method to announce in CONNECT. The broker may then send challenges, which are answered by the MqttAuthHandler registered with MqttClient::set_auth_handler. Requires MqttVersion::V5.

auth_data: Option<Vec<u8>>

Initial Authentication Data sent with CONNECT (e.g. a SCRAM client-first message). Requires Self::auth_method.

Implementations

impl ConnectOptions

pub fn new( host: impl Into<String>, port: u16, client_id: impl Into<String>, version: MqttVersion, ) -> Self

Trait Implementations

impl Clone for ConnectOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for ConnectOptions

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for ConnectOptions

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

Formats the value using the given formatter.

impl Eq for ConnectOptions

impl<UT> FfiConverter<UT> for ConnectOptions

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a MetadataBuffer.

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for ConnectOptions

type FfiType = <ConnectOptions as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for ConnectOptions

type LiftType = ConnectOptions

impl<UT> LiftReturn<UT> for ConnectOptions

type ReturnType = <ConnectOptions as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for ConnectOptions

type FfiType = <ConnectOptions as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for ConnectOptions

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for ConnectOptions

type ReturnType = <ConnectOptions as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl PartialEq for ConnectOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ConnectOptions

impl<UT> TypeId<UT> for ConnectOptions

const TYPE_ID_META: MetadataBuffer