MQTT_SerializeUnsubscribe

Serialize an MQTT UNSUBSCRIBE packet in the given buffer.

MQTTStatus_t MQTT_SerializeUnsubscribe( const MQTTSubscribeInfo_t * pSubscriptionList,
                                        size_t subscriptionCount,
                                        uint16_t packetId,
                                        size_t remainingLength,
                                        const MQTTFixedBuffer_t * pFixedBuffer );

MQTT_GetUnsubscribePacketSize should be called with pSubscriptionList before invoking this function to get the size of the required MQTTFixedBuffer_t and remainingLength. The remainingLength must be the same as returned by MQTT_GetUnsubscribePacketSize. The MQTTFixedBuffer_t must be at least as large as the size returned by MQTT_GetUnsubscribePacketSize.

Parameters

[in]	pSubscriptionList	List of MQTT subscription info.
[in]	subscriptionCount	The number of elements in pSubscriptionList.
[in]	packetId	packet ID generated by MQTT_GetPacketId.
[in]	remainingLength	Remaining Length provided by MQTT_GetUnsubscribePacketSize.
[out]	pFixedBuffer	Buffer for packet serialization.

Returns

MQTTNoMemory if pFixedBuffer is too small to hold the MQTT packet; MQTTBadParameter if invalid parameters are passed; MQTTSuccess otherwise.

Example

// Variables used in this example.
MQTTStatus_t status;
MQTTSubscribeInfo_t subscriptionList[ NUMBER_OF_SUBSCRIPTIONS ] = { 0 };
MQTTFixedBuffer_t fixedBuffer;
uint8_t buffer[ BUFFER_SIZE ];
size_t remainingLength = 0, packetSize = 0;
uint16_t packetId;
 
fixedBuffer.pBuffer = buffer;
fixedBuffer.size = BUFFER_SIZE;
 
// Function to return a valid, unused packet identifier. The details are out of
// scope for this example.
packetId = getNewPacketId();
 
// Assume subscriptionList has been initialized. Get the unsubscribe packet size.
status = MQTT_GetUnsubscribePacketSize(
     &subscriptionList[ 0 ], NUMBER_OF_SUBSCRIPTIONS, &remainingLength, &packetSize
);
assert( status == MQTTSuccess );
assert( packetSize <= BUFFER_SIZE );
 
// Serialize the unsubscribe packet into the fixed buffer.
status = MQTT_SerializeUnsubscribe(
     &subscriptionList[ 0 ],
     NUMBER_OF_SUBSCRIPTIONS,
     packetId,
     remainingLength,
     &fixedBuffer
);
 
if( status == MQTTSuccess )
{
     // The unsubscribe packet can now be sent to the broker.
}