Struct actix_mqtt_client::MqttClient

pub struct MqttClient { /* fields omitted */ }

The client for connecting to the MQTT server

Methods

impl MqttClient

pub fn new<TReader: AsyncRead + Send + 'static, TWriter: Write + Send + 'static>(
    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 fn connect(&mut self) -> Box<dyn Future<Item = (), Error = 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

pub fn subscribe(
    &self,
    topic: String,
    qos: QualityOfService
) -> Box<dyn Future<Item = (), Error = IoError>>

Subscribe to the server with a topic and QoS

pub fn unsubscribe(
    &self,
    topic: String
) -> Box<dyn Future<Item = (), Error = IoError>>

Unsubscribe from the server

pub fn publish(
    &self,
    topic: String,
    qos: QualityOfService,
    payload: Vec<u8>
) -> Box<dyn Future<Item = (), Error = IoError>>

Publish a message

pub fn disconnect(
    &mut self,
    force: bool
) -> Box<dyn Future<Item = (), Error = IoError>>

Disconnect from the server

pub fn is_disconnected(&self) -> bool

Check if the client has been disconnect from the server, useful to check whether disconnect is success

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.