acl::mqtt_ack类 参考

#include <mqtt_ack.hpp>

类 acl::mqtt_ack 继承关系图:

acl::mqtt_ack 的协作图:

Public 成员函数
	mqtt_ack (mqtt_type_t type)
	mqtt_ack (const mqtt_header &header)
virtual	~mqtt_ack (void)
void	set_pkt_id (unsigned short id)
unsigned short	get_pkt_id (void) const
int	update_header_var (const char *data, int dlen)
Public 成员函数 继承自 acl::mqtt_message
	mqtt_message (mqtt_type_t type)
	mqtt_message (const mqtt_header &header)
virtual	~mqtt_message (void)
mqtt_header &	get_header (void)
const mqtt_header &	get_header (void) const

Protected 成员函数
bool	to_string (string &out)
int	update (const char *data, int dlen)
bool	finished (void) const
Protected 成员函数 继承自 acl::mqtt_message
void	pack_add (unsigned char ch, string &out)
void	pack_add (unsigned short n, string &out)
void	pack_add (const string &s, string &out)
bool	unpack_short (const char *data, size_t len, unsigned short &out)

额外继承的成员函数
静态 Public 成员函数 继承自 acl::mqtt_message
static mqtt_message *	create_message (const mqtt_header &header)
Protected 属性 继承自 acl::mqtt_message
mqtt_header	header_

详细描述

the base class for acking some mqtt message, used by some mqtt message type.

在文件 mqtt_ack.hpp 第 10 行定义.

构造及析构函数说明

mqtt_ack() [1/2]

acl::mqtt_ack::mqtt_ack

(

mqtt_type_t

type

)

usually used when build a ack mqtt message.

参数

type	{mqtt_type_t}

mqtt_ack() [2/2]

acl::mqtt_ack::mqtt_ack

(

const mqtt_header &

header

)

usually used when parsing a ack mqtt messsage.

参数

header

{const mqtt_header&} will be copied internal.

~mqtt_ack()

virtual acl::mqtt_ack::~mqtt_ack ( void  )

virtual

成员函数说明

finished()

bool acl::mqtt_ack::finished ( void  ) const

inlineprotectedvirtual

重载 acl::mqtt_message .

在文件 mqtt_ack.hpp 第 48 行定义.

                                  {
                return finished_;
        }

get_pkt_id()

unsigned short acl::mqtt_ack::get_pkt_id ( void  ) const

inline

get the mqtt message's id

返回

{unsigned short} if some error happened, 0 will be returned.

在文件 mqtt_ack.hpp 第 36 行定义.

                                              {
                return pkt_id_;
        }

set_pkt_id()

void acl::mqtt_ack::set_pkt_id

(

unsigned short

id

)

set the mqtt message's id.

参数

id	{unsigned short} should > 0 && <= 65535.

to_string()

bool acl::mqtt_ack::to_string ( string &  out )

protectedvirtual

实现了 acl::mqtt_message.

update()

int acl::mqtt_ack::update ( const char *  data, int  dlen  )

protectedvirtual

实现了 acl::mqtt_message.

update_header_var()

int acl::mqtt_ack::update_header_var	(	const char *	data,
		int	dlen
	)

---

该类的文档由以下文件生成:

• include/acl_cpp/mqtt/mqtt_ack.hpp