Struct MqttConnector

pub struct MqttConnector<A, T> { /* private fields */ }

Mqtt client connector

Implementations

impl<A> MqttConnector<A, ()>

where A: Address + Clone,

pub fn new(address: A) -> MqttConnector<A, Connector<A>>

Create new mqtt connector

impl<A, T> MqttConnector<A, T>

where A: Address + Clone,

pub fn client_id<U>(self, client_id: U) -> Self

where ByteString: From<U>,

Create new client and provide client id

pub fn clean_start(self) -> Self

The handling of the Session state.

pub fn keep_alive(self, val: Seconds) -> Self

A time interval measured in seconds.

keep-alive is set to 30 seconds by default.

pub fn last_will(self, val: LastWill) -> Self

Will Message be stored on the Server and associated with the Network Connection.

by default last will value is not set

pub fn auth(self, method: ByteString, data: Bytes) -> Self

Set auth-method and auth-data for connect packet.

pub fn username(self, val: ByteString) -> Self

Username can be used by the Server for authentication and authorization.

pub fn password(self, val: Bytes) -> Self

Password can be used by the Server for authentication and authorization.

pub fn max_packet_size(self, val: u32) -> Self

Max incoming packet size.

To disable max size limit set value to 0.

pub fn min_chunk_size(self, size: u32) -> Self

Set min payload chunk size.

If the minimum size is set to 0, incoming payload chunks will be processed immediately. Otherwise, the codec will accumulate chunks until the total size reaches the specified minimum. By default min size is set to 0

pub fn max_receive(self, val: u16) -> Self

Set receive max

Number of in-flight incoming publish packets. By default receive max is set to 16 packets. To disable in-flight limit set value to 0.

pub fn properties<F>(self, f: F) -> Self

where F: FnOnce(&mut UserProperties),

Update connect user properties

pub fn packet<F>(self, f: F) -> Self

where F: FnOnce(&mut Connect),

Update connect packet

pub fn handshake_timeout(self, timeout: Seconds) -> Self

Set handshake timeout.

Handshake includes connect packet and response connect-ack. By default handshake timeuot is disabled.

pub fn disconnect_timeout(self, timeout: Seconds) -> Self

Set client connection disconnect timeout.

Defines a timeout for disconnect connection. If a disconnect procedure does not complete within this time, the connection get dropped.

To disable timeout set value to 0.

By default disconnect timeout is set to 3 seconds.

pub fn memory_pool(self, id: PoolId) -> Self

Set memory pool.

Use specified memory pool for memory allocations. By default P5 memory pool is used.

pub fn connector<U, F>(self, connector: F) -> MqttConnector<A, U>

where F: IntoService<U, Connect<A>>, U: Service<Connect<A>, Error = ConnectError>, IoBoxed: From<U::Response>,

Use custom connector

impl<A, T> MqttConnector<A, T>

where A: Address + Clone, T: Service<Connect<A>, Error = ConnectError>, IoBoxed: From<T::Response>,

pub async fn connect(&self) -> Result<Client, ClientError<Box<ConnectAck>>>

Connect to mqtt server