acl::mqtt_connack类 参考

#include <mqtt_connack.hpp>

类 acl::mqtt_connack 继承关系图:

acl::mqtt_connack 的协作图:

Public 成员函数
	mqtt_connack (void)
	mqtt_connack (const mqtt_header &header)
	~mqtt_connack (void)
mqtt_connack &	set_session (bool on)
mqtt_connack &	set_connack_code (unsigned char code)
bool	get_session (void) const
unsigned char	get_connack_code (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_

详细描述

mqtt message object for the MQTT_CONNACK type.

在文件 mqtt_connack.hpp 第 22 行定义.

构造及析构函数说明

mqtt_connack() [1/2]

acl::mqtt_connack::mqtt_connack

(

void

)

constructor for creating MQTT_CONNACK mqtt message object.

参见

mqtt_message

mqtt_connack() [2/2]

acl::mqtt_connack::mqtt_connack

(

const mqtt_header &

header

)

constructor for creating MQTT_CONNACK mqtt message object.

参见

mqtt_message

~mqtt_connack()

acl::mqtt_connack::~mqtt_connack

(

void

)

成员函数说明

finished()

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

inlineprotectedvirtual

重载 acl::mqtt_message .

在文件 mqtt_connack.hpp 第 76 行定义.

                                  {
                return finished_;
        }

get_connack_code()

unsigned char acl::mqtt_connack::get_connack_code ( void  ) const

inline

get the connect resturn code

返回

{unsigned char} defined as MQTT_CONNACK_XXX above.

在文件 mqtt_connack.hpp 第 64 行定义.

                                                   {
                return connack_code_;
        }

get_session()

bool acl::mqtt_connack::get_session ( void  ) const

inline

get the session control status

返回

{bool}

在文件 mqtt_connack.hpp 第 56 行定义.

                                     {
                return session_;
        }

set_connack_code()

mqtt_connack& acl::mqtt_connack::set_connack_code

(

unsigned char

code

)

set the connect return code

参数

code	{unsigned char} defined as MQTT_CONNACK_XXX above.

返回

{mqtt_connack&}

set_session()

mqtt_connack& acl::mqtt_connack::set_session

(

bool

on

)

set the session control for the connection

参数

on

{bool}

返回

{mqtt_connack&}

to_string()

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

protectedvirtual

实现了 acl::mqtt_message.

update()

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

protectedvirtual

实现了 acl::mqtt_message.

update_header_var()

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

(internal) update mqtt header data for parsing mqtt data.

参数

data	{const char*} the data to be parsed.
dlen	{int} the length of data.

返回

{int} return the length of the left data.

---

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

• include/acl_cpp/mqtt/mqtt_connack.hpp