Struct paho_mqtt::client::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

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

Implementations

source

impl Client

source

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

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

source

pub fn timeout(&self) -> Duration

Gets the default timeout used for synchronous operations.

source

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.

source

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.

source

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.

source

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.

source

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.

source

pub fn is_connected(&self) -> bool

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

source

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

Publishes a message to an MQTT broker

Subscribes to a single topic.

Arguments

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

source

pub fn subscribe_with_options<S, T, P>(
 &self,
 topic: S,
 qos: i32,
 opts: T,
 props: P
) -> Result<ServerResponse> where
 S: Into<String>,
 T: Into<SubscribeOptions>,
 P: Into<Option<Properties>>,

Subscribes to a single topic with v5 options

Arguments

topic The topic name qos The quality of service requested for messages opts Options for the subscription props MQTT v5 properties

source

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

source

pub fn subscribe_many_with_options<T, P>(
 &self,
 topics: &[T],
 qos: &[i32 ],
 opts: &[SubscribeOptions ],
 props: P
) -> Result<ServerResponse> where
 T: AsRef<str>,
 P: Into<Option<Properties>>,

Subscribes to multiple topics simultaneously with options.

Arguments

topics The collection of topic names qos The quality of service requested for messages opts Subscribe options (one per topic) props MQTT v5 properties

source

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.

source

pub fn unsubscribe_with_options<S>(
 &self,
 topic: S,
 props: Properties
) -> Result<()> where
 S: Into<String>,

Unsubscribes from a single topic.

Arguments

topic The topic to unsubscribe. It must match a topic from a previous subscribe. props MQTT v5 properties for the unsubscribe.

source

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.

source

pub fn unsubscribe_many_with_options<T>(
 &self,
 topics: &[T],
 props: Properties
) -> 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. props MQTT v5 properties for the unsubscribe.

source

pub fn start_consuming(&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.

source