mqtt_publish_param Struct Reference

Parameters for a publish message (PUBLISH). More...

#include <mqtt.h>

Data Fields
struct mqtt_publish_message	message
	Messages including topic, QoS and its payload (if any) to be published.
uint16_t	message_id
	Message id used for the publish message.
uint8_t	dup_flag: 1
	Duplicate flag.
uint8_t	retain_flag: 1
	Retain flag.
struct {
struct mqtt_utf8_pair   user_prop [CONFIG_MQTT_USER_PROPERTIES_MAX]
	MQTT 5.0, chapter 3.3.2.3.7 User Property. More...
struct mqtt_utf8   response_topic
	MQTT 5.0, chapter 3.3.2.3.5 Response Topic. More...
struct mqtt_binstr   correlation_data
	MQTT 5.0, chapter 3.3.2.3.6 Correlation Data. More...
struct mqtt_utf8   content_type
	MQTT 5.0, chapter 3.3.2.3.9 Content Type. More...
uint32_t   subscription_identifier [CONFIG_MQTT_SUBSCRIPTION_ID_PROPERTIES_MAX]
	MQTT 5.0, chapter 3.3.2.3.8 Subscription Identifier. More...
uint32_t   message_expiry_interval
	MQTT 5.0, chapter 3.3.2.3.3 Message Expiry Interval. More...
uint16_t   topic_alias
	MQTT 5.0, chapter 3.3.2.3.4 Topic Alias. More...
uint8_t   payload_format_indicator
	MQTT 5.0, chapter 3.3.2.3.2 Payload Format Indicator. More...
struct {
bool   has_payload_format_indicator
	Payload Format Indicator property was present. More...
bool   has_message_expiry_interval
	Message Expiry Interval property was present. More...
bool   has_topic_alias
	Topic Alias property was present. More...
bool   has_response_topic
	Response Topic property was present. More...
bool   has_correlation_data
	Correlation Data property was present. More...
bool   has_user_prop
	User Property property was present. More...
bool   has_subscription_identifier
	Subscription Identifier property was present. More...
bool   has_content_type
	Content Type property was present. More...
}   rx
	Flags indicating whether given property was present in received packet. More...
}	prop
	MQTT 5.0 properties.

Detailed Description

Parameters for a publish message (PUBLISH).

Field Documentation

content_type

struct mqtt_utf8 mqtt_publish_param::content_type

MQTT 5.0, chapter 3.3.2.3.9 Content Type.

correlation_data

struct mqtt_binstr mqtt_publish_param::correlation_data

MQTT 5.0, chapter 3.3.2.3.6 Correlation Data.

dup_flag

uint8_t mqtt_publish_param::dup_flag

Duplicate flag.

If 1, it indicates the message is being retransmitted. Has no meaning with QoS 0.

has_content_type

bool mqtt_publish_param::has_content_type

Content Type property was present.

has_correlation_data

bool mqtt_publish_param::has_correlation_data

Correlation Data property was present.

has_message_expiry_interval

bool mqtt_publish_param::has_message_expiry_interval

Message Expiry Interval property was present.

has_payload_format_indicator

bool mqtt_publish_param::has_payload_format_indicator

Payload Format Indicator property was present.

has_response_topic

bool mqtt_publish_param::has_response_topic

Response Topic property was present.

has_subscription_identifier

bool mqtt_publish_param::has_subscription_identifier

Subscription Identifier property was present.

has_topic_alias

bool mqtt_publish_param::has_topic_alias

Topic Alias property was present.

has_user_prop

bool mqtt_publish_param::has_user_prop

User Property property was present.

message

struct mqtt_publish_message mqtt_publish_param::message

Messages including topic, QoS and its payload (if any) to be published.

message_expiry_interval

uint32_t mqtt_publish_param::message_expiry_interval

MQTT 5.0, chapter 3.3.2.3.3 Message Expiry Interval.

message_id

uint16_t mqtt_publish_param::message_id

Message id used for the publish message.

Redundant for QoS 0.

payload_format_indicator

uint8_t mqtt_publish_param::payload_format_indicator

MQTT 5.0, chapter 3.3.2.3.2 Payload Format Indicator.

[struct]

struct { ... } mqtt_publish_param::prop

MQTT 5.0 properties.

response_topic

struct mqtt_utf8 mqtt_publish_param::response_topic

MQTT 5.0, chapter 3.3.2.3.5 Response Topic.

retain_flag

uint8_t mqtt_publish_param::retain_flag

Retain flag.

If 1, the message shall be stored persistently by the broker.

[struct]

struct { ... } mqtt_publish_param::rx

Flags indicating whether given property was present in received packet.

subscription_identifier

uint32_t mqtt_publish_param::subscription_identifier[CONFIG_MQTT_SUBSCRIPTION_ID_PROPERTIES_MAX]

MQTT 5.0, chapter 3.3.2.3.8 Subscription Identifier.

topic_alias

uint16_t mqtt_publish_param::topic_alias

MQTT 5.0, chapter 3.3.2.3.4 Topic Alias.

user_prop

struct mqtt_utf8_pair mqtt_publish_param::user_prop[CONFIG_MQTT_USER_PROPERTIES_MAX]

MQTT 5.0, chapter 3.3.2.3.7 User Property.

---

The documentation for this struct was generated from the following file:

• include/zephyr/net/mqtt.h