Struct MqttCommon

pub struct MqttCommon {
    pub url: String,
    pub qos: Option<QualityOfService>,
    pub user: Option<String>,
    pub password: Option<String>,
    pub client_prefix: Option<String>,
    pub clean_start: bool,
    pub inflight_messages: Option<usize>,
    pub max_packet_size: Option<u32>,
    pub ca: Option<String>,
    pub client_cert: Option<String>,
    pub client_key: Option<String>,
}

Fields

url: String

The url of the broker to connect to. e.g. tcp://localhost. Must be prefixed with one of either tcp://, mqtt://, ssl://,mqtts://, to denote the protocol for establishing a connection with the broker. mqtts://, ssl:// will use the native certificates if no ca is specified

qos: Option<QualityOfService>

The quality of service to use when publishing messages. Defaults to at_most_once. Could be at_most_once, at_least_once or exactly_once

user: Option<String>

Username for the mqtt broker

password: Option<String>

Password for the mqtt broker

client_prefix: Option<String>

Prefix for the mqtt client id. The client id will be generated as client_prefixactor_id(executor_id|source_id). Defaults to risingwave

clean_start: bool

clean_start = true removes all the state from queues & instructs the broker to clean all the client state when client disconnects.

When set false, broker will hold the client state and performs pending operations on the client when reconnection with same client_id happens. Local queue state is also held to retransmit packets after reconnection.

inflight_messages: Option<usize>

The maximum number of inflight messages. Defaults to 100

max_packet_size: Option<u32>

The max size of messages received by the MQTT client

ca: Option<String>

Path to CA certificate file for verifying the broker’s key.

client_cert: Option<String>

Path to client’s certificate file (PEM). Required for client authentication. Can be a file path under fs:// or a string with the certificate content.

client_key: Option<String>

Path to client’s private key file (PEM). Required for client authentication. Can be a file path under fs:// or a string with the private key content.

Implementations

impl MqttCommon

pub(crate) fn build_client( &self, actor_id: u32, id: u64, ) -> ConnectorResult<(AsyncClient, EventLoop)>

pub(crate) fn qos(&self) -> QoS

fn get_tls_config(&self) -> ConnectorResult<ClientConfig>

Trait Implementations

impl Clone for MqttCommon

fn clone(&self) -> MqttCommon

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MqttCommon

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MqttCommon

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl WithOptions for MqttCommon