pahomqtt/MQTTPacket/MQTTSubscribe.h File Reference

Macros
#define	DLLExport
#define	DLLImport

Functions
DLLExport int	MQTTDeserialize_suback (unsigned short *packetid, int maxcount, int *count, int grantedQoSs[], unsigned char *buf, int len)
	Deserializes the supplied (wire) buffer into suback data. More...
DLLExport int	MQTTDeserialize_subscribe (unsigned char *dup, unsigned short *packetid, int maxcount, int *count, MQTTString topicFilters[], int requestedQoSs[], unsigned char *buf, int len)
	Deserializes the supplied (wire) buffer into subscribe data. More...
DLLExport int	MQTTSerialize_suback (unsigned char *buf, int buflen, unsigned short packetid, int count, int *grantedQoSs)
	Serializes the supplied suback data into the supplied buffer, ready for sending. More...
DLLExport int	MQTTSerialize_subscribe (unsigned char *buf, int buflen, unsigned char dup, unsigned short packetid, int count, MQTTString topicFilters[], int requestedQoSs[])
	Serializes the supplied subscribe data into the supplied buffer, ready for sending. More...

#define DLLExport

#define DLLImport

DLLExport int MQTTDeserialize_suback	(	unsigned short *	packetid,
		int	maxcount,
		int *	count,
		int	grantedQoSs[],
		unsigned char *	buf,
		int	buflen
	)

Deserializes the supplied (wire) buffer into suback data.

Parameters

packetid	returned integer - the MQTT packet identifier
maxcount	- the maximum number of members allowed in the grantedQoSs array
count	returned integer - number of members in the grantedQoSs array
grantedQoSs	returned array of integers - the granted qualities of service
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 MQTTHeader::bits, buf, MQTTHeader::byte, FUNC_ENTRY, FUNC_EXIT_RC, header, MQTTPacket_decodeBuf(), NULL, readChar(), readInt(), SUBACK, and MQTTHeader::type.

Referenced by MQTTFormat_toClientString(), MQTTResubscribe(), and MQTTSubscribe().

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

Deserializes the supplied (wire) buffer into subscribe 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
requestedQoSs	- array of requested QoS
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, count, MQTTHeader::dup, FUNC_ENTRY, FUNC_EXIT_RC, header, MQTTPacket_decodeBuf(), NULL, readChar(), readInt(), readMQTTLenString(), SUBSCRIBE, and MQTTHeader::type.

Referenced by MQTTFormat_toServerString().

DLLExport int MQTTSerialize_suback	(	unsigned char *	buf,
		int	buflen,
		unsigned short	packetid,
		int	count,
		int *	grantedQoSs
	)

Serializes the supplied suback 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
count	- number of members in the grantedQoSs array
grantedQoSs	- array of granted QoS

Returns

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

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

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

Serializes the supplied subscribe 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 bufferr
dup	integer - the MQTT dup flag
packetid	integer - the MQTT packet identifier
count	- number of members in the topicFilters and reqQos arrays
topicFilters	- array of topic filter names
requestedQoSs	- array of requested QoS

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_subscribeLength(), ptr, MQTTHeader::qos, SUBSCRIBE, MQTTHeader::type, writeChar(), writeInt(), and writeMQTTString().

Referenced by MQTTResubscribe(), and MQTTSubscribe().