Struct ntex_mqtt::v5::client::MqttConnector

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

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,
    T: Service<Request = Connect<A>, Error = ConnectError>,
    T::Response: AsyncRead + AsyncWrite + Unpin + 'static, 

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: u16) -> 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 receive_max(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: u16) -> Self

Set handshake timeout in milliseconds.

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

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

Set client connection disconnect timeout in milliseconds.

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 connector<U>(self, connector: U) -> MqttConnector<A, U> where
    U: Service<Request = Connect<A>, Error = ConnectError>,
    U::Response: AsyncRead + AsyncWrite + Unpin + 'static, 

Use custom connector

pub fn connect(
    &self
) -> impl Future<Output = Result<Client<T::Response>, ClientError>>

Connect to mqtt server