Struct minimq::config::ConfigBuilder

pub struct ConfigBuilder<'a, Broker: Broker> { /* private fields */ }

Configuration specifying the operational state of the MQTT client.

Implementations

impl<'a, Broker: Broker> ConfigBuilder<'a, Broker>

pub fn new(broker: Broker, buffer: &'a mut [u8]) -> Self

Construct configuration for the MQTT client.

Args

• buffer - Memory used by the MQTT client. This memory is used for the will, the message receive buffer, the transmission buffer, and the client session state.

pub fn session_state(self, config: BufferConfig) -> Self

Specify a specific configuration for the session state buffer.

Note

The session state buffer is used for publications greater than [QoS::AtMostOnce]. If these messages are unused, you can specify [BufferConfig::Exactly(0)].

Args

• config - The configuration for the size of the session state buffer.

pub fn rx_buffer(self, config: BufferConfig) -> Self

Specify a specific configuration for the message receive buffer.

Args

• config - The configuration for the size of the receive buffer.

pub fn tx_buffer(self, config: BufferConfig) -> Self

Specify a specific configuration for the message transmit buffer.

Args

• config - The configuration for the size of the message transmit buffer.

pub fn client_id(self, id: &str) -> Result<Self, ProtocolError>

Specify a known client ID to use. If not assigned, the broker will auto assign an ID.

pub fn keepalive_interval(self, seconds: u16) -> Self

Configure the MQTT keep-alive interval.

Note

The broker may override the requested keep-alive interval. Any value requested by the broker will be used instead.

Args

• interval - The keep-alive interval in seconds. A ping will be transmitted if no other messages are sent within 50% of the keep-alive interval.

pub fn autodowngrade_qos(self) -> Self

Specify if publication [QoS] should be automatically downgraded to the maximum supported by the server if they exceed the server [QoS] maximum.

pub fn will(self, will: Will<'_>) -> Result<Self, ProtocolError>

Specify the Will message to be sent if the client disconnects.

Args

• will - The will to use.

Trait Implementations

impl<'a, Broker: Debug + Broker> Debug for ConfigBuilder<'a, Broker>

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

Formats the value using the given formatter.