Struct minimq::MqttClient

pub struct MqttClient<T, N> where
    T: ArrayLength<u8>,
    N: TcpStack,  {
    pub network_stack: N,
    // some fields omitted
}

A client for interacting with an MQTT Broker.

Fields

network_stack: N

The network stack originally provided to the client.

Implementations

impl<T, N> MqttClient<T, N> where
    T: ArrayLength<u8>,
    N: TcpStack, 

pub fn new<'a>(
    broker: IpAddr,
    client_id: &'a str,
    network_stack: N
) -> Result<Self, Error<N::Error>>

Construct a new MQTT client.

Args

• broker - The IP address of the broker to connect to.
• client_id The client ID to use for communicating with the broker.
• network_stack - The network stack to use for communication.

Returns

An MqttClient that can be used for publishing messages and subscribing to topics.

pub fn subscribe<'a, 'b>(
    &self,
    topic: &'a str,
    properties: &[Property<'b>]
) -> Result<(), Error<N::Error>>

Subscribe to a topic.

Note

A subscription is not maintained across a disconnection with the broker. In the case of MQTT disconnections, topics will need to be subscribed to again.

Args

• topic - The topic to subscribe to.
• properties - A list of properties to attach to the subscription request. May be empty.

pub fn subscriptions_pending(&self) -> bool

Determine if any subscriptions are waiting for completion.

Returns

True if any subscriptions are waiting for confirmation from the broker.

pub fn is_connected(&self) -> Result<bool, Error<N::Error>>

Determine if the client has established a connection with the broker.

Returns

True if the client is connected to the broker.

pub fn publish<'a, 'b>(
    &self,
    topic: &'a str,
    data: &[u8],
    qos: QoS,
    properties: &[Property<'a>]
) -> Result<(), Error<N::Error>>

Publish a message over MQTT.

Note

If the client is not yet connected to the broker, the message will be silently ignored.

Note

Currently, Only QoS level 1 (at most once) delivery is supported.

Args

• topic - The topic to publish the message to.
• data - The data to transmit as the message contents.
• qos - The desired quality-of-service level of the message. Must be QoS::AtMostOnce
• properties - A list of properties to associate with the message being published. May be empty.

pub fn poll<F>(&mut self, f: F) -> Result<(), Error<N::Error>> where
    F: FnMut(&Self, &'a str, &[u8], &[Property<'a>]), 

Check the MQTT interface for available messages.

Args

• f - A closure to process any received messages. The closure should accept the client, topic, message, and list of proprties (in that order).