Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

MQTT 3.1.1 client.

Wraps ove_mqtt_client_t with automatic cleanup on drop.

Implementations§

Source§

impl Client

Source

pub fn new() -> Result<Self>

Create a new MQTT client via heap allocation (only in heap mode).

Source

pub fn create(storage: &mut ClientStorage) -> Result<Self>

Create a client that works in both heap and zero-heap modes.

Source

pub fn connect(&mut self, cfg: &Config<'_>, on_message: MessageFn) -> Result<()>

Connect to an MQTT broker.

on_message is called for each incoming publish (topic + payload).

§Errors

Returns an error if the connection or MQTT handshake fails.

Source

pub fn disconnect(&mut self)

Disconnect from the MQTT broker.

Source

pub fn publish(&self, topic: &[u8], payload: &[u8], qos: Qos) -> Result<()>

Publish a message on a topic.

topic must be a null-terminated byte string.

§Errors

Returns an error if the publish fails.

Source

pub fn subscribe(&self, topic: &[u8], qos: Qos) -> Result<()>

Subscribe to a topic filter.

topic must be a null-terminated byte string.

§Errors

Returns an error if the subscribe fails.

Source

pub fn unsubscribe(&self, topic: &[u8]) -> Result<()>

Unsubscribe from a topic filter.

topic must be a null-terminated byte string.

§Errors

Returns an error if the unsubscribe fails.

Source

pub fn poll(&self, timeout_ms: u32) -> Result<()>

Process incoming packets and send keep-alive pings.

Must be called periodically (in a loop or from a timer callback).

§Errors

Returns an error if the poll encounters a protocol or transport error.

Trait Implementations§

Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Drop for Client

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for Client

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.