Struct mosquitto_client::Mosquitto

pub struct Mosquitto { /* fields omitted */ }

Mosquitto client

Methods

impl Mosquitto

fn new(id: &str) -> Mosquitto

create a new mosquitto instance, providing a client name. Clients connecting to a broker must have unique names

fn callbacks<'a, T>(&'a self, data: T) -> Callbacks<'a, T>

create a Callback object so you can listen to events.

fn connect(&self, host: &str, port: u32) -> Result<()>

connect to the broker. You can only be fully sure that a connection succeeds after the on_connect callback returns non-zero

fn connect_wait(&self, host: &str, port: u32, millis: i32) -> Result<()>

connect to the broker, waiting for success.

fn threaded(&self)

call if you wish to use Mosquitto in a multithreaded environment.

fn reconnect_delay_set(
    &self,
    delay: u32,
    delay_max: u32,
    exponential_backoff: bool
) -> Result<()>

fn subscribe<'a>(&'a self, sub: &str, qos: u32) -> Result<TopicMatcher<'a>>

subscribe to an MQTT topic, with a desired quality-of-service. The returned value can be used to directly match against received messages, and has a mid field identifying the subscribing request. on_subscribe will be called with this identifier.

fn unsubscribe(&self, sub: &str) -> Result<i32>

unsubcribe from an MQTT topic - on_unsubscribe callback will be called.

fn publish(
    &self,
    topic: &str,
    payload: &[u8],
    qos: u32,
    retain: bool
) -> Result<i32>

publish an MQTT message to the broker, returning message id. Quality-of-service and whether retained can be specified. To be sure, check the message id passed to the on_publish callback

fn will_set(
    &self,
    topic: &str,
    payload: &[u8],
    qos: u32,
    retain: bool
) -> Result<()>

fn will_clear(&self) -> Result<()>

fn publish_wait(
    &self,
    topic: &str,
    payload: &[u8],
    qos: u32,
    retain: bool,
    millis: i32
) -> Result<i32>

publish an MQTT message to the broker, returning message id after waiting for successful publish

fn disconnect(&self) -> Result<()>

explicitly disconnect from the broker.

fn do_loop(&self, timeout: i32) -> Result<()>

process network events for at most timeout milliseconds. -1 will mean the default, 1000ms.

fn loop_forever(&self, timeout: i32) -> Result<()>

process network events. This will handle intermittent disconnects for you, but will return after an explicit disconnect() call

fn loop_until_disconnect(&self, timeout: i32) -> Result<()>

loop forever, but do not regard an explicit disconnect as an error.

Trait Implementations

impl Send for Mosquitto

impl Sync for Mosquitto

impl Clone for Mosquitto

fn clone(&self) -> Mosquitto

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Mosquitto

fn drop(&mut self)

Executes the destructor for this type.