Struct actix_mqtt_client::MqttClient

pub struct MqttClient { /* fields omitted */ }

The client for connecting to the MQTT server

Implementations

impl MqttClient

pub fn new<TReader: AsyncRead + Send + 'static + Unpin, TWriter: AsyncWrite + Send + 'static + Unpin>(
    reader: TReader,
    writer: TWriter,
    client_name: String,
    options: MqttOptions,
    message_recipient: Recipient<PublishMessage>,
    error_recipient: Recipient<ErrorMessage>,
    stop_recipient: Option<Recipient<StopMessage>>
) -> Self

Create a new MQTT client

pub fn name(&self) -> &str

Returns the name of the client

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

Perform the connect operation to the remote MQTT server

Note: This function can only be called once for each client, calling it the second time will return an error Note: The successful return of this function DOES NOT mean that the MQTT connection is successful, if anything wrong happens the error actor will receive an error Note: Please use is_connected() to check whether the MQTT connection is successful or not

pub async fn is_connected<'_>(&'_ self) -> IoResult<bool>

Check whether the client has connected to the server successfully

pub async fn subscribe<'_>(
    &'_ self,
    topic: String,
    qos: QualityOfService
) -> Result<(), IoError>

Subscribe to the server with a topic and QoS

pub async fn unsubscribe<'_>(&'_ self, topic: String) -> Result<(), IoError>

Unsubscribe from the server

pub async fn publish<'_>(
    &'_ self,
    topic: String,
    qos: QualityOfService,
    payload: Vec<u8>
) -> Result<(), IoError>

Publish a message

pub async fn disconnect<'_>(&'_ mut self, force: bool) -> Result<(), IoError>

Disconnect from the server

pub fn is_disconnected(&self) -> bool

Check if the client has been disconnected from the server, useful to check whether disconnection is completed

Trait Implementations

impl Clone for MqttClient

fn clone(&self) -> MqttClient

Returns a copy of the value.

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

Performs copy-assignment from source.