Struct mqttrust_core::MqttOptions
source · [−]pub struct MqttOptions<'a> { /* private fields */ }
Expand description
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
sourceimpl<'a> MqttOptions<'a>
impl<'a> MqttOptions<'a>
sourcepub fn set_broker(self, broker: Broker<'a>) -> Self
pub fn set_broker(self, broker: Broker<'a>) -> Self
Broker address
pub fn set_port(self, port: u16) -> Self
pub fn set_last_will(self, will: LastWill<'a>) -> Self
pub fn last_will(&self) -> Option<LastWill<'a>>
sourcepub fn set_keep_alive(self, secs: u16) -> Self
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
sourcepub fn keep_alive_ms(&self) -> u32
pub fn keep_alive_ms(&self) -> u32
Keep alive time
sourcepub fn set_clean_session(self, clean_session: bool) -> Self
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.
sourcepub fn clean_session(&self) -> bool
pub fn clean_session(&self) -> bool
Clean session
sourcepub fn set_credentials(self, username: &'a str, password: &'a [u8]) -> Self
pub fn set_credentials(self, username: &'a str, password: &'a [u8]) -> Self
Username and password
Trait Implementations
sourceimpl<'a> Clone for MqttOptions<'a>
impl<'a> Clone for MqttOptions<'a>
sourcefn clone(&self) -> MqttOptions<'a>
fn clone(&self) -> MqttOptions<'a>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations
impl<'a> RefUnwindSafe for MqttOptions<'a>
impl<'a> Send for MqttOptions<'a>
impl<'a> Sync for MqttOptions<'a>
impl<'a> Unpin for MqttOptions<'a>
impl<'a> UnwindSafe for MqttOptions<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more