Struct AsyncClient

pub struct AsyncClient { /* private fields */ }

An asynchronous client, communicates with MQTT EventLoop.

This is cloneable and can be used to asynchronously publish, subscribe through the EventLoop, which is to be polled parallelly.

NOTE: The EventLoop must be regularly polled in order to send, receive and process packets from the broker, i.e. move ahead.

Implementations

impl AsyncClient

pub fn new(options: MqttOptions, cap: usize) -> (AsyncClient, EventLoop)

Create a new AsyncClient.

cap specifies the capacity of the bounded async channel.

pub fn from_senders(request_tx: Sender<(NoticeTx, Request)>) -> AsyncClient

Create a new AsyncClient from a channel Sender.

This is mostly useful for creating a test instance where you can listen on the corresponding receiver.

pub async fn publish_with_properties<S, P>( &self, topic: S, qos: QoS, retain: bool, payload: P, properties: PublishProperties, ) -> Result<NoticeFuture, ClientError>

where S: Into<String>, P: Into<Bytes>,

pub async fn publish<S, P>( &self, topic: S, qos: QoS, retain: bool, payload: P, ) -> Result<NoticeFuture, ClientError>

where S: Into<String>, P: Into<Bytes>,

pub fn try_publish_with_properties<S, P>( &self, topic: S, qos: QoS, retain: bool, payload: P, properties: PublishProperties, ) -> Result<NoticeFuture, ClientError>

where S: Into<String>, P: Into<Bytes>,

pub fn try_publish<S, P>( &self, topic: S, qos: QoS, retain: bool, payload: P, ) -> Result<NoticeFuture, ClientError>

where S: Into<String>, P: Into<Bytes>,

pub async fn ack(&self, publish: &Publish) -> Result<NoticeFuture, ClientError>

Sends a MQTT PubAck to the EventLoop. Only needed in if manual_acks flag is set.

pub fn try_ack(&self, publish: &Publish) -> Result<NoticeFuture, ClientError>

Attempts to send a MQTT PubAck to the EventLoop. Only needed in if manual_acks flag is set.

pub async fn publish_bytes_with_properties<S>( &self, topic: S, qos: QoS, retain: bool, payload: Bytes, properties: PublishProperties, ) -> Result<NoticeFuture, ClientError>

where S: Into<String>,

pub async fn publish_bytes<S>( &self, topic: S, qos: QoS, retain: bool, payload: Bytes, ) -> Result<NoticeFuture, ClientError>

where S: Into<String>,

pub async fn subscribe_with_properties<S: Into<String>>( &self, topic: S, qos: QoS, properties: SubscribeProperties, ) -> Result<NoticeFuture, ClientError>

pub async fn subscribe<S: Into<String>>( &self, topic: S, qos: QoS, ) -> Result<NoticeFuture, ClientError>

pub fn try_subscribe_with_properties<S: Into<String>>( &self, topic: S, qos: QoS, properties: SubscribeProperties, ) -> Result<NoticeFuture, ClientError>

pub fn try_subscribe<S: Into<String>>( &self, topic: S, qos: QoS, ) -> Result<NoticeFuture, ClientError>

pub async fn subscribe_many_with_properties<T>( &self, topics: T, properties: SubscribeProperties, ) -> Result<NoticeFuture, ClientError>

where T: IntoIterator<Item = Filter>,

pub async fn subscribe_many<T>( &self, topics: T, ) -> Result<NoticeFuture, ClientError>

where T: IntoIterator<Item = Filter>,

pub fn try_subscribe_many_with_properties<T>( &self, topics: T, properties: SubscribeProperties, ) -> Result<NoticeFuture, ClientError>

where T: IntoIterator<Item = Filter>,

pub fn try_subscribe_many<T>( &self, topics: T, ) -> Result<NoticeFuture, ClientError>

where T: IntoIterator<Item = Filter>,

pub async fn unsubscribe_with_properties<S: Into<String>>( &self, topic: S, properties: UnsubscribeProperties, ) -> Result<NoticeFuture, ClientError>

pub async fn unsubscribe<S: Into<String>>( &self, topic: S, ) -> Result<NoticeFuture, ClientError>

pub fn try_unsubscribe_with_properties<S: Into<String>>( &self, topic: S, properties: UnsubscribeProperties, ) -> Result<NoticeFuture, ClientError>

pub fn try_unsubscribe<S: Into<String>>( &self, topic: S, ) -> Result<NoticeFuture, ClientError>

pub async fn disconnect(&self) -> Result<NoticeFuture, ClientError>

Sends a MQTT disconnect to the EventLoop

pub fn try_disconnect(&self) -> Result<NoticeFuture, ClientError>

Attempts to send a MQTT disconnect to the EventLoop

Trait Implementations

impl Clone for AsyncClient

fn clone(&self) -> AsyncClient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AsyncClient

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

Formats the value using the given formatter.