Struct paho_mqtt3as_sys::MQTTAsync_willOptions
[−]
[src]
#[repr(C)]pub struct MQTTAsync_willOptions { pub struct_id: [c_char; 4], pub struct_version: c_int, pub topicName: *const c_char, pub message: *const c_char, pub retained: c_int, pub qos: c_int, pub payload: MQTTAsync_willOptions__bindgen_ty_1, }
MQTTAsync_willOptions defines the MQTT "Last Will and Testament" (LWT) settings for the client. In the event that a client unexpectedly loses its connection to the server, the server publishes the LWT message to the LWT topic on behalf of the client. This allows other clients (subscribed to the LWT topic) to be made aware that the client has disconnected. To enable the LWT function for a specific client, a valid pointer to an MQTTAsync_willOptions structure is passed in the MQTTAsync_connectOptions structure used in the MQTTAsync_connect() call that connects the client to the server. The pointer to MQTTAsync_willOptions can be set to NULL if the LWT function is not required.
Fields
struct_id: [c_char; 4]
The eyecatcher for this structure. must be MQTW.
struct_version: c_int
The version number of this structure. Must be 0 or 1 0 indicates no binary will message support
topicName: *const c_char
The LWT topic to which the LWT message will be published.
message: *const c_char
The LWT payload.
retained: c_int
The retained flag for the LWT message (see MQTTAsync_message.retained).
qos: c_int
The quality of service setting for the LWT message (see MQTTAsync_message.qos and @ref qos).
payload: MQTTAsync_willOptions__bindgen_ty_1
Trait Implementations
impl Debug for MQTTAsync_willOptions
[src]
impl Copy for MQTTAsync_willOptions
[src]
impl Clone for MQTTAsync_willOptions
[src]
fn clone(&self) -> Self
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl Default for MQTTAsync_willOptions
[src]
fn default() -> MQTTAsync_willOptions
Returns the "default value" for a type. Read more