Struct mqtt_async_client::client::Client

pub struct Client { /* fields omitted */ }

An MQTT client.

Start building an instance by calling Client::builder() to get a ClientBuilder, using the fluent builder pattern on ClientBuilder, then calling ClientBuilder::build(). For example:

let client =
    Client::builder()
       .set_host("example.com".to_owned())
       .build();

Methods

impl Client

pub fn builder() -> ClientBuilder

Start a fluent builder interface to construct a Client.

pub async fn connect<'_>(&'_ mut self) -> Result<()>

Open a connection to the configured MQTT broker.

pub async fn publish<'_, '_>(&'_ self, p: &'_ Publish) -> Result<()>

Publish some data on a topic.

Note that this method takes &self. This means a caller can create several publish futures to publish several payloads of data simultaneously without waiting for responses.

pub async fn subscribe<'_>(
    &'_ mut self,
    s: Subscribe
) -> Result<SubscribeResult>

Subscribe to some topics.read_subscriptions will return data for them.

pub async fn unsubscribe<'_>(&'_ mut self, u: Unsubscribe) -> Result<()>

Unsubscribe from some topics. read_subscriptions will no longer return data for them.

pub async fn read_subscriptions<'_>(&'_ mut self) -> Result<ReadResult>

Wait for the next Publish packet for one of this Client's subscriptions.

pub async fn disconnect<'_>(&'_ mut self) -> Result<()>

Gracefully close the connection to the server.