pahomqtt/MQTTPacket/MQTTUnsubscribe.h File Reference

Macros
#define	DLLExport
#define	DLLImport

Functions
DLLExport int	MQTTDeserialize_unsuback (unsigned short *packetid, unsigned char *buf, int len)
	Deserializes the supplied (wire) buffer into unsuback data. More...
DLLExport int	MQTTDeserialize_unsubscribe (unsigned char *dup, unsigned short *packetid, int max_count, int *count, MQTTString topicFilters[], unsigned char *buf, int len)
	Deserializes the supplied (wire) buffer into unsubscribe data. More...
DLLExport int	MQTTSerialize_unsuback (unsigned char *buf, int buflen, unsigned short packetid)
	Serializes the supplied unsuback data into the supplied buffer, ready for sending. More...
DLLExport int	MQTTSerialize_unsubscribe (unsigned char *buf, int buflen, unsigned char dup, unsigned short packetid, int count, MQTTString topicFilters[])
	Serializes the supplied unsubscribe data into the supplied buffer, ready for sending. More...

#define DLLExport

#define DLLImport

DLLExport int MQTTDeserialize_unsuback	(	unsigned short *	packetid,
		unsigned char *	buf,
		int	buflen
	)

Deserializes the supplied (wire) buffer into unsuback data.

Parameters

packetid	returned integer - the MQTT packet identifier
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

error code. 1 is success, 0 is failure

References FUNC_ENTRY, FUNC_EXIT_RC, MQTTDeserialize_ack(), and UNSUBACK.

Referenced by MQTTFormat_toClientString(), and MQTTUnsubscribe().

DLLExport int MQTTDeserialize_unsubscribe	(	unsigned char *	dup,
		unsigned short *	packetid,
		int	maxcount,
		int *	count,
		MQTTString	topicFilters[],
		unsigned char *	buf,
		int	len
	)

Deserializes the supplied (wire) buffer into unsubscribe data.

Parameters

dup	integer returned - the MQTT dup flag
packetid	integer returned - the MQTT packet identifier
maxcount	- the maximum number of members allowed in the topicFilters and requestedQoSs arrays
count	- number of members in the topicFilters and requestedQoSs arrays
topicFilters	- array of topic filter names
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

the length of the serialized data. <= 0 indicates error

References MQTTHeader::bits, buf, MQTTHeader::byte, MQTTHeader::dup, FUNC_ENTRY, FUNC_EXIT_RC, header, MQTTPacket_decodeBuf(), NULL, readChar(), readInt(), readMQTTLenString(), MQTTHeader::type, and UNSUBSCRIBE.

Referenced by MQTTFormat_toServerString().

DLLExport int MQTTSerialize_unsuback	(	unsigned char *	buf,
		int	buflen,
		unsigned short	packetid
	)

Serializes the supplied unsuback data into the supplied buffer, ready for sending.

Parameters

buf	the buffer into which the packet will be serialized
buflen	the length in bytes of the supplied buffer
packetid	integer - the MQTT packet identifier

Returns

the length of the serialized data. <= 0 indicates error

References MQTTHeader::bits, buf, MQTTHeader::byte, FUNC_ENTRY, FUNC_EXIT_RC, header, MQTTPACKET_BUFFER_TOO_SHORT, MQTTPacket_encode(), ptr, MQTTHeader::type, UNSUBACK, writeChar(), and writeInt().

DLLExport int MQTTSerialize_unsubscribe	(	unsigned char *	buf,
		int	buflen,
		unsigned char	dup,
		unsigned short	packetid,
		int	count,
		MQTTString	topicFilters[]
	)

Serializes the supplied unsubscribe data into the supplied buffer, ready for sending.

Parameters

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
dup	integer - the MQTT dup flag
packetid	integer - the MQTT packet identifier
count	- number of members in the topicFilters array
topicFilters	- array of topic filter names

Returns

the length of the serialized data. <= 0 indicates error

References MQTTHeader::bits, buf, MQTTHeader::byte, count, MQTTHeader::dup, FUNC_ENTRY, FUNC_EXIT_RC, header, i, MQTTPACKET_BUFFER_TOO_SHORT, MQTTPacket_encode(), MQTTPacket_len(), MQTTSerialize_unsubscribeLength(), ptr, MQTTHeader::qos, MQTTHeader::type, UNSUBSCRIBE, writeChar(), writeInt(), and writeMQTTString().

Referenced by MQTTUnsubscribe().