Struct rumqttc::AsyncClient

pub struct AsyncClient { /* private fields */ }

AsyncClient to communicate with MQTT Eventloop This is cloneable and can be used to asynchronously Publish, Subscribe.

Implementations

impl AsyncClient

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

Create a new AsyncClient

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

Create a new AsyncClient from a pair of async channel Senders. This is mostly useful for creating a test instance.

pub async fn publish<S, V>(
    &self,
    topic: S,
    qos: QoS,
    retain: bool,
    payload: V
) -> Result<(), ClientError> where
    S: Into<String>,
    V: Into<Vec<u8>>, 

Sends a MQTT Publish to the eventloop

pub fn try_publish<S, V>(
    &self,
    topic: S,
    qos: QoS,
    retain: bool,
    payload: V
) -> Result<(), ClientError> where
    S: Into<String>,
    V: Into<Vec<u8>>, 

Sends a MQTT Publish to the eventloop

pub async fn ack(&self, publish: &Publish) -> Result<(), 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<(), ClientError>

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

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

Sends a MQTT Publish to the eventloop

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

Sends a MQTT Subscribe to the eventloop

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

Sends a MQTT Subscribe to the eventloop

pub async fn subscribe_many<T>(&self, topics: T) -> Result<(), ClientError> where
    T: IntoIterator<Item = SubscribeFilter>, 

Sends a MQTT Subscribe for multiple topics to the eventloop

pub fn try_subscribe_many<T>(&self, topics: T) -> Result<(), ClientError> where
    T: IntoIterator<Item = SubscribeFilter>, 

Sends a MQTT Subscribe for multiple topics to the eventloop

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

Sends a MQTT Unsubscribe to the eventloop

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

Sends a MQTT Unsubscribe to the eventloop

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

Sends a MQTT disconnect to the eventloop

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

Sends a MQTT disconnect to the eventloop

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

Stops the eventloop right away

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.