mqtt_prop模块头文件, 提供mqtt 5.0用户属性管理的能力更多...

#include <stdint.h>

aiot_mqtt_props_api.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

类
struct	len_value_t
	value-length 结构体. 更多...

struct	user_property_t
	MQTT 5.0协议中用户属性更多...

struct	mqtt_property_t

struct	mqtt_properties_t

枚举
enum	mqtt_property_identify_t { MQTT_PROP_ID_PAYLOAD_FORMAT_INDICATOR = 1, MQTT_PROP_ID_MESSAGE_EXPIRY_INTERVAL = 2, MQTT_PROP_ID_CONTENT_TYPE = 3, MQTT_PROP_ID_RESPONSE_TOPIC = 8, MQTT_PROP_ID_CORRELATION_DATA = 9, MQTT_PROP_ID_SUBSCRIPTION_IDENTIFIER = 11, MQTT_PROP_ID_SESSION_EXPIRY_INTERVAL = 17, MQTT_PROP_ID_ASSIGNED_CLIENT_IDENTIFER = 18, MQTT_PROP_ID_SERVER_KEEP_ALIVE = 19, MQTT_PROP_ID_AUTHENTICATION_METHOD = 21, MQTT_PROP_ID_AUTHENTICATION_DATA = 22, MQTT_PROP_ID_REQUEST_PROBLEM_INFORMATION = 23, MQTT_PROP_ID_WILL_DELAY_INTERVAL = 24, MQTT_PROP_ID_REQUEST_RESPONSE_INFORMATION = 25, MQTT_PROP_ID_RESPONSE_INFORMATION = 26, MQTT_PROP_ID_SERVER_REFERENCE = 28, MQTT_PROP_ID_REASON_STRING = 31, MQTT_PROP_ID_RECEIVE_MAXIMUM = 33, MQTT_PROP_ID_TOPIC_ALIAS_MAXIMUM = 34, MQTT_PROP_ID_TOPIC_ALIAS = 35, MQTT_PROP_ID_MAXIMUM_QOS = 36, MQTT_PROP_ID_RETAIN_AVAILABLE = 37, MQTT_PROP_ID_USER_PROPERTY = 38, MQTT_PROP_ID_MAXIMUM_PACKET_SIZE = 39, MQTT_PROP_ID_WILDCARD_SUBSCRIPTION_AVAILABLE = 40, MQTT_PROP_ID_SUBSCRIPTION_IDENTIFIERS_AVAILABLE = 41, MQTT_PROP_ID_SHARED_SUBSCRIPTION_AVAILABLE = 42 }

enum	mqtt_property_type_t { MQTT_PROP_TYPE_UINT8, MQTT_PROP_TYPE_UINT16, MQTT_PROP_TYPE_UINT32, MQTT_PROP_TYPE_VARIABLE, MQTT_PROP_TYPE_BINARY, MQTT_PROP_TYPE_STRING, MQTT_PROP_TYPE_STRING_PAIR, MQTT_PROP_ID_INVALID = 0xFF }

函数
mqtt_properties_t *	aiot_mqtt_props_init ()
	mqtt消息属性集合初始化更多...

int32_t	aiot_mqtt_props_add (mqtt_properties_t props, mqtt_property_t prop)
	向属性集合中增加一条属性更多...

mqtt_property_t *	aiot_mqtt_props_get (mqtt_properties_t *props, mqtt_property_identify_t id, int32_t index)
	从属性集合中，查询属性更多...

void	aiot_mqtt_props_deinit (mqtt_properties_t **props)
	属性集合反初始化，回收资源更多...

int32_t	aiot_mqtt_props_print (mqtt_properties_t *props)
	printf属性内容更多...

mqtt_properties_t *	aiot_mqtt_props_copy (mqtt_properties_t *props)
	深拷贝属性更多...

详细描述

mqtt_prop模块头文件, 提供mqtt 5.0用户属性管理的能力

版权所有: Copyright (C) 2015-2020 Alibaba Group Holding Limited

枚举类型说明

enum mqtt_property_identify_t

The one byte MQTT V5 property indicator

枚举值
MQTT_PROP_ID_PAYLOAD_FORMAT_INDICATOR
MQTT_PROP_ID_MESSAGE_EXPIRY_INTERVAL
MQTT_PROP_ID_CONTENT_TYPE
MQTT_PROP_ID_RESPONSE_TOPIC
MQTT_PROP_ID_CORRELATION_DATA
MQTT_PROP_ID_SUBSCRIPTION_IDENTIFIER
MQTT_PROP_ID_SESSION_EXPIRY_INTERVAL
MQTT_PROP_ID_ASSIGNED_CLIENT_IDENTIFER
MQTT_PROP_ID_SERVER_KEEP_ALIVE
MQTT_PROP_ID_AUTHENTICATION_METHOD
MQTT_PROP_ID_AUTHENTICATION_DATA
MQTT_PROP_ID_REQUEST_PROBLEM_INFORMATION
MQTT_PROP_ID_WILL_DELAY_INTERVAL
MQTT_PROP_ID_REQUEST_RESPONSE_INFORMATION
MQTT_PROP_ID_RESPONSE_INFORMATION
MQTT_PROP_ID_SERVER_REFERENCE
MQTT_PROP_ID_REASON_STRING
MQTT_PROP_ID_RECEIVE_MAXIMUM
MQTT_PROP_ID_TOPIC_ALIAS_MAXIMUM
MQTT_PROP_ID_TOPIC_ALIAS
MQTT_PROP_ID_MAXIMUM_QOS
MQTT_PROP_ID_RETAIN_AVAILABLE
MQTT_PROP_ID_USER_PROPERTY
MQTT_PROP_ID_MAXIMUM_PACKET_SIZE
MQTT_PROP_ID_WILDCARD_SUBSCRIPTION_AVAILABLE
MQTT_PROP_ID_SUBSCRIPTION_IDENTIFIERS_AVAILABLE
MQTT_PROP_ID_SHARED_SUBSCRIPTION_AVAILABLE

enum mqtt_property_type_t

枚举值
MQTT_PROP_TYPE_UINT8
MQTT_PROP_TYPE_UINT16
MQTT_PROP_TYPE_UINT32
MQTT_PROP_TYPE_VARIABLE
MQTT_PROP_TYPE_BINARY
MQTT_PROP_TYPE_STRING
MQTT_PROP_TYPE_STRING_PAIR
MQTT_PROP_ID_INVALID

函数说明

mqtt_properties_t* aiot_mqtt_props_init ( )

mqtt消息属性集合初始化

返回: mqtt_properties_t *

返回值

NULL	执行失败
非空NULL	执行成功

函数调用图:

int32_t aiot_mqtt_props_add	(	mqtt_properties_t *	props,
		mqtt_property_t *	prop
	)

向属性集合中增加一条属性

参数

[in]	props	属性集合
[in]	prop	单个属性

返回: int32_t

返回值

<STATE_SUCCESS	执行失败
>=STATE_SUCCESS	执行成功

函数调用图:

mqtt_property_t* aiot_mqtt_props_get	(	mqtt_properties_t *	props,
		mqtt_property_identify_t	id,
		int32_t	index
	)

从属性集合中，查询属性

参数

[in]	props	属性集合
[in]	id	属性的identifer
[in]	index	序号，相同id存在多个属性时，属性的序号

返回: mqtt_properties_t *

返回值

NULL	执行失败
非空NULL	执行成功

void aiot_mqtt_props_deinit ( mqtt_properties_t ** props )

属性集合反初始化，回收资源

参数

[in] props 属性集合

函数调用图:

int32_t aiot_mqtt_props_print ( mqtt_properties_t * props )

printf属性内容

参数

[in] props 属性集合

函数调用图:

mqtt_properties_t* aiot_mqtt_props_copy ( mqtt_properties_t * props )

深拷贝属性

参数

[in] props 属性集合

函数调用图: