Struct paho_mqtt::client::Client

pub struct Client { /* fields omitted */ }

MQTT Client with a synchronous (blocking) API. This is simply a convenience wrapper around the asynchronous API, providing blocking calls with timeouts.

Implementations

impl Client

pub fn new<T>(opts: T) -> Result<Client> where
    T: Into<CreateOptions>, 

Creates a new MQTT client which can connect to an MQTT broker.

pub fn timeout(&self) -> Duration

Gets the default timeout used for synchronous operations.

pub fn set_timeout(&mut self, timeout: Duration)

Sets the default timeout used for synchronous operations.

Arguments

timeout The timeout to use for synchronous calls, like connect(), disconnect(), publish(), etc.

pub fn connect<T>(&self, opt_opts: T) -> Result<ServerResponse> where
    T: Into<Option<ConnectOptions>>, 

Connects to an MQTT broker using the specified connect options.

pub fn disconnect<T>(&self, opt_opts: T) -> Result<()> where
    T: Into<Option<DisconnectOptions>>, 

Disconnects from the MQTT broker.

Arguments

opt_opts Optional disconnect options. Specifying None will use default of immediate (zero timeout) disconnect.

pub fn disconnect_after(&self, timeout: Duration) -> Result<()>

Disconnect from the MQTT broker with a timeout. This will delay the disconnect for up to the specified timeout to allow in-flight messages to complete. This is the same as calling disconnect with options specifying a timeout.

Arguments

timeout The amount of time to wait for the disconnect. This has a resolution in milliseconds.

pub fn reconnect(&self) -> Result<ServerResponse>

Attempts to reconnect to the broker. This can only be called after a connection was initially made or attempted. It will retry with the same connect options.

pub fn is_connected(&self) -> bool

Determines if this client is currently connected to an MQTT broker.

pub fn publish(&self, msg: Message) -> Result<()>

Publishes a message to an MQTT broker

pub fn subscribe(&self, topic: &str, qos: i32) -> Result<ServerResponse>

Subscribes to a single topic.

Arguments

topic The topic name qos The quality of service requested for messages

pub fn subscribe_many<T>(
    &self,
    topics: &[T],
    qos: &[i32]
) -> Result<ServerResponse> where
    T: AsRef<str>, 

Subscribes to multiple topics simultaneously.

Arguments

topic The topic name qos The quality of service requested for messages

pub fn unsubscribe(&self, topic: &str) -> Result<()>

Unsubscribes from a single topic.

Arguments

topic The topic to unsubscribe. It must match a topic from a previous subscribe.

pub fn unsubscribe_many<T>(&self, topics: &[T]) -> Result<()> where
    T: AsRef<str>, 

Unsubscribes from multiple topics simultaneously.

Arguments

topic The topics to unsubscribe. Each must match a topic from a previous subscribe.

pub fn start_consuming(&mut self) -> Receiver<Option<Message>>

Starts the client consuming messages. This starts the client receiving messages and placing them into an mpsc queue. It returns the receiving-end of the queue for the application to get the messages. This can be called at any time after the client is created, but it should be called before subscribing to any topics, otherwise messages can be lost.