AWS_SDK/AWS_SDK/aws_mqtt_embedded_client_lib/MQTTPacket/src/MQTTConnect.h File Reference

Data Structures
union	MQTTConnackFlags
union	MQTTConnectFlags
struct	MQTTPacket_connectData
struct	MQTTPacket_willOptions
	Defines the MQTT "Last Will and Testament" (LWT) settings for the connect packet. More...

Macros
#define	DLLExport
#define	DLLImport
#define	MQTTPacket_connectData_initializer
#define	MQTTPacket_willOptions_initializer   { {'M', 'Q', 'T', 'W'}, 0, {NULL, {0, NULL}}, {NULL, {0, NULL}}, 0, 0 }

Enumerations
enum	MQTTConnackReturnCodes {   CONNACK_CONNECTION_ACCEPTED = 0,   CONANCK_UNACCEPTABLE_PROTOCOL_VERSION_ERROR = 1,   CONNACK_IDENTIFIER_REJECTED_ERROR = 2,   CONNACK_SERVER_UNAVAILABLE_ERROR = 3,   CONNACK_BAD_USERDATA_ERROR = 4,   CONNACK_NOT_AUTHORIZED_ERROR = 5 }

Functions
DLLExport MQTTReturnCode	MQTTDeserialize_connack (unsigned char *sessionPresent, MQTTReturnCode *connack_rc, unsigned char *buf, size_t buflen)
	Deserializes the supplied (wire) buffer into connack data - return code. More...
DLLExport MQTTReturnCode	MQTTSerialize_connect (unsigned char *buf, size_t buflen, MQTTPacket_connectData *options, uint32_t *serialized_len)
	Serializes the connect options into the buffer. More...
DLLExport MQTTReturnCode	MQTTSerialize_disconnect (unsigned char *buf, size_t buflen, uint32_t *serialized_length)
	Serializes a disconnect packet into the supplied buffer, ready for writing to a socket. More...
DLLExport MQTTReturnCode	MQTTSerialize_pingreq (unsigned char *buf, size_t buflen, uint32_t *serialized_length)
	Serializes a pingreq packet into the supplied buffer, ready for writing to a socket. More...

#define DLLExport

#define DLLImport

#define MQTTPacket_connectData_initializer

Value:

{ {'M', 'Q', 'T', 'C'}, 0, 4, {NULL, {0, NULL}}, 60, 1, 0, \
		MQTTPacket_willOptions_initializer, {NULL, {0, NULL}}, {NULL, {0, NULL}} }

#define MQTTPacket_willOptions_initializer   { {'M', 'Q', 'T', 'W'}, 0, {NULL, {0, NULL}}, {NULL, {0, NULL}}, 0, 0 }

enum MQTTConnackReturnCodes

Enumerator
CONNACK_CONNECTION_ACCEPTED
CONANCK_UNACCEPTABLE_PROTOCOL_VERSION_ERROR
CONNACK_IDENTIFIER_REJECTED_ERROR
CONNACK_SERVER_UNAVAILABLE_ERROR
CONNACK_BAD_USERDATA_ERROR
CONNACK_NOT_AUTHORIZED_ERROR

DLLExport MQTTReturnCode MQTTDeserialize_connack	(	unsigned char *	sessionPresent,
		MQTTReturnCode *	connack_rc,
		unsigned char *	buf,
		size_t	buflen
	)

Deserializes the supplied (wire) buffer into connack data - return code.

Parameters

sessionPresent	the session present flag returned (only for MQTT 3.1.1)
connack_rc	returned integer value of the connack return code
buf	the raw buffer data, of the correct length determined by the remaining length field
buflen	the length in bytes of the data in the supplied buffer

Returns

MQTTReturnCode indicating function execution status

References MQTTConnackFlags::all, MQTTHeader::bits, MQTTConnackFlags::bits, buf, MQTTHeader::byte, CONANCK_UNACCEPTABLE_PROTOCOL_VERSION_ERROR, CONNACK, CONNACK_BAD_USERDATA_ERROR, CONNACK_CONNECTION_ACCEPTED, CONNACK_IDENTIFIER_REJECTED_ERROR, CONNACK_NOT_AUTHORIZED_ERROR, CONNACK_SERVER_UNAVAILABLE_ERROR, FAILURE, FUNC_ENTRY, FUNC_EXIT_RC, header, MQTT_CONANCK_UNACCEPTABLE_PROTOCOL_VERSION_ERROR, MQTT_CONNACK_BAD_USERDATA_ERROR, MQTT_CONNACK_CONNECTION_ACCEPTED, MQTT_CONNACK_IDENTIFIER_REJECTED_ERROR, MQTT_CONNACK_NOT_AUTHORIZED_ERROR, MQTT_CONNACK_SERVER_UNAVAILABLE_ERROR, MQTT_CONNACK_UNKNOWN_ERROR, MQTT_NULL_VALUE_ERROR, MQTTPACKET_BUFFER_TOO_SHORT, MQTTPacket_decodeBuf(), NULL, readChar(), MQTTConnackFlags::sessionpresent, SUCCESS, and MQTTHeader::type.

DLLExport MQTTReturnCode MQTTSerialize_connect	(	unsigned char *	buf,
		size_t	buflen,
		MQTTPacket_connectData *	options,
		uint32_t *	serialized_len
	)

Serializes the connect options into the buffer.

Parameters

buf	the buffer into which the packet will be serialized
len	the length in bytes of the supplied buffer
options	the options to be used to build the connect packet
serialized	length

Returns

MQTTReturnCode indicating function execution status

References MQTTConnectFlags::all, MQTTConnectFlags::bits, buf, MQTTHeader::byte, MQTTConnectFlags::cleansession, MQTTPacket_connectData::cleansession, MQTTPacket_connectData::clientID, CONNECT, MQTTString::cstring, MQTTLenString::data, FUNC_ENTRY, FUNC_EXIT_RC, header, MQTTPacket_connectData::keepAliveInterval, len, MQTTString::lenstring, MQTTPacket_willOptions::message, MQTT_NULL_VALUE_ERROR, MQTTPACKET_BUFFER_TOO_SHORT, MQTTPacket_encode(), MQTTPacket_InitHeader(), MQTTPacket_len(), MQTTSerialize_GetConnectLength(), MQTTPacket_connectData::MQTTVersion, NULL, MQTTConnectFlags::password, MQTTPacket_connectData::password, ptr, MQTTPacket_willOptions::qos, QOS0, MQTTPacket_willOptions::retained, SUCCESS, MQTTPacket_willOptions::topicName, MQTTConnectFlags::username, MQTTPacket_connectData::username, MQTTConnectFlags::will, MQTTPacket_connectData::will, MQTTPacket_connectData::willFlag, MQTTConnectFlags::willQoS, MQTTConnectFlags::willRetain, writeChar(), writeCString(), writeInt(), and writeMQTTString().

DLLExport MQTTReturnCode MQTTSerialize_disconnect	(	unsigned char *	buf,
		size_t	buflen,
		uint32_t *	serialized_length
	)

Serializes a disconnect packet into the supplied buffer, ready for writing to a socket.

Parameters

buf	the buffer into which the packet will be serialized
buflen	the length in bytes of the supplied buffer, to avoid overruns
serialized	length

Returns

MQTTReturnCode indicating function execution status

References DISCONNECT, and MQTTSerialize_zero().

DLLExport MQTTReturnCode MQTTSerialize_pingreq	(	unsigned char *	buf,
		size_t	buflen,
		uint32_t *	serialized_length
	)

Serializes a pingreq packet into the supplied buffer, ready for writing to a socket.

Parameters

buf	the buffer into which the packet will be serialized
buflen	the length in bytes of the supplied buffer, to avoid overruns
serialized	length

Returns

MQTTReturnCode indicating function execution status

References MQTTSerialize_zero(), and PINGREQ.