Struct EventLoop

pub struct EventLoop {
    pub options: MqttOptions,
    pub state: MqttState,
    /* private fields */
}

Eventloop with all the state of a connection

Fields

options: MqttOptions

Options of the current mqtt connection

state: MqttState

Current state of the connection

Implementations

impl EventLoop

pub fn new(options: MqttOptions, cap: usize) -> EventLoop

New MQTT EventLoop

When connection encounters critical errors (like auth failure), user has a choice to access and update options, state and requests.

pub fn clean(&mut self)

Last session might contain packets which aren’t acked. MQTT says these packets should be republished in the next session. Move pending messages from state to eventloop, drops the underlying network connection and clears the keepalive timeout if any.

NOTE: Use only when EventLoop is blocked on network and unable to immediately handle disconnect. Also, while this helps prevent data loss, the pending list length should be managed properly. For this reason we recommend setting AsycClient’s channel capacity to 0.

pub async fn poll(&mut self) -> Result<Event, ConnectionError>

Yields Next notification or outgoing request and periodically pings the broker. Continuing to poll will reconnect to the broker if there is a disconnection. NOTE Don’t block this while iterating