Structure describing an MQTT-SN client. More...

#include <zephyr/net/mqtt_sn.h>

Data Fields
struct mqtt_sn_data	client_id
	1-23 character unique client ID
struct mqtt_sn_data	will_topic
	Topic for Will message.
struct mqtt_sn_data	will_msg
	Will message.
enum mqtt_sn_qos	will_qos
	Quality of Service for the Will message.
bool	will_retain
	Flag indicating if the will message should be retained by the broker.
struct mqtt_sn_transport *	transport
	Underlying transport to be used by the client.
struct net_buf_simple	tx
	Buffer for outgoing data.
struct net_buf_simple	rx
	Buffer for incoming data.
struct net_buf_simple	rx_addr
	Buffer for incoming data sender address.
mqtt_sn_evt_cb_t	evt_cb
	Event callback.
uint16_t	next_msg_id
	Message ID for the next message to be sent.
sys_slist_t	publish
	List of pending publish messages.
sys_slist_t	topic
	List of registered topics.
sys_slist_t	gateway
	List of found gateways.
int	state
	Current state of the MQTT-SN client.
int64_t	last_ping
	Timestamp of the last ping request.
uint8_t	ping_retries
	Number of retries for failed ping attempts.
int64_t	ts_searchgw
	Timestamp of the next SEARCHGW transmission.
int64_t	ts_gwinfo
	Timestamp of the next GWINFO transmission.
int64_t	radius_gwinfo
	Radius of the next GWINFO transmission.
struct mqtt_sn_will_update	will_topic_update
	State for will topic updates.
struct mqtt_sn_will_update	will_message_update
	State for will message updates.
struct k_work_delayable	process_work
	Delayable work structure for processing MQTT-SN events.

Detailed Description

Structure describing an MQTT-SN client.

Field Documentation

◆ client_id

struct mqtt_sn_data mqtt_sn_client::client_id

1-23 character unique client ID

◆ evt_cb

mqtt_sn_evt_cb_t mqtt_sn_client::evt_cb

Event callback.

◆ gateway

sys_slist_t mqtt_sn_client::gateway

List of found gateways.

◆ last_ping

int64_t mqtt_sn_client::last_ping

Timestamp of the last ping request.

◆ next_msg_id

uint16_t mqtt_sn_client::next_msg_id

Message ID for the next message to be sent.

◆ ping_retries

uint8_t mqtt_sn_client::ping_retries

Number of retries for failed ping attempts.

◆ process_work

struct k_work_delayable mqtt_sn_client::process_work

Delayable work structure for processing MQTT-SN events.

◆ publish

sys_slist_t mqtt_sn_client::publish

List of pending publish messages.

◆ radius_gwinfo

int64_t mqtt_sn_client::radius_gwinfo

Radius of the next GWINFO transmission.

◆ rx

struct net_buf_simple mqtt_sn_client::rx

Buffer for incoming data.

◆ rx_addr

struct net_buf_simple mqtt_sn_client::rx_addr

Buffer for incoming data sender address.

◆ state

int mqtt_sn_client::state

Current state of the MQTT-SN client.

◆ topic

sys_slist_t mqtt_sn_client::topic

List of registered topics.

◆ transport

struct mqtt_sn_transport* mqtt_sn_client::transport

Underlying transport to be used by the client.

◆ ts_gwinfo

int64_t mqtt_sn_client::ts_gwinfo

Timestamp of the next GWINFO transmission.

◆ ts_searchgw

int64_t mqtt_sn_client::ts_searchgw

Timestamp of the next SEARCHGW transmission.

◆ tx

struct net_buf_simple mqtt_sn_client::tx

Buffer for outgoing data.

◆ will_message_update

struct mqtt_sn_will_update mqtt_sn_client::will_message_update

State for will message updates.

◆ will_msg

struct mqtt_sn_data mqtt_sn_client::will_msg

Will message.

Must be initialized before connecting with will=true

◆ will_qos

enum mqtt_sn_qos mqtt_sn_client::will_qos

Quality of Service for the Will message.

◆ will_retain

bool mqtt_sn_client::will_retain

Flag indicating if the will message should be retained by the broker.

◆ will_topic

struct mqtt_sn_data mqtt_sn_client::will_topic

Topic for Will message.