IotMqtt_SerializeUnsubscribe

Generate a UNSUBSCRIBE packet from the given parameters.

IotMqttError_t IotMqtt_SerializeUnsubscribe( const IotMqttSubscription_t * pSubscriptionList,
                                             size_t subscriptionCount,
                                             size_t remainingLength,
                                             uint16_t * pPacketIdentifier,
                                             uint8_t * pBuffer,
                                             size_t bufferSize );

Parameters

[in]	pSubscriptionList	User-provided array of subscriptions to remove.
[in]	subscriptionCount	Size of pSubscriptionList.
[in]	remainingLength	remaining length of the packet to be serialized.
[out]	pPacketIdentifier	The packet identifier generated for this UNSUBSCRIBE.
[in,out]	pBuffer	User provide buffer where the UNSUBSCRIBE packet is written.
[in]	bufferSize	Size of the buffer pointed to by pBuffer.

Returns

IOT_MQTT_SUCCESS or IOT_MQTT_NO_MEMORY.

Note

pBuffer must be allocated by caller.

This call is part of serializer API used for implementing light-weight MQTT client.

Example

// Example code below shows how IotMqtt_SerializeUnsubscribe() should be used to serialize
// MQTT unsubscribe packet and send it to MQTT broker.
// Example uses static memory, but dynamically allocated memory can be used as well.
// Get size requirement for the Unsubscribe packet.

#define mqttexampleSHARED_BUFFER_SIZE 100
static ucSharedBuffer[mqttexampleSHARED_BUFFER_SIZE];
void sendUnsubscribePacket( int xMQTTSocket )
{
   // Following example shows one topic example.
   IotMqttSubscription_t xMQTTSubscription[ 1 ];
   size_t xRemainingLength = 0;
   size_t xPacketSize = 0;
   IotMqttError_t xResult;
   size_t xSentBytes = 0;
   // Get size requirement for MQTT unsubscribe packet.
   xResult = IotMqtt_GetSubscriptionPacketSize( IOT_MQTT_UNSUBSCRIBE,
                                             xMQTTSubscription,
                                             sizeof( xMQTTSubscription ) / sizeof( IotMqttSubscription_t ),
                                             &xRemainingLength, &xPacketSize );
   IotMqtt_Assert( xResult == IOT_MQTT_SUCCESS );
   // Make sure the packet size is less than static buffer size.
   IotMqtt_Assert( xPacketSize < mqttexampleSHARED_BUFFER_SIZE );
   // Serialize subscribe into statically allocated ucSharedBuffer.
    xResult = IotMqtt_SerializeUnsubscribe( xMQTTSubscription,
                                      sizeof( xMQTTSubscription ) / sizeof( IotMqttSubscription_t ),
                                      xRemainingLength,
                                      &usPacketIdentifier,
                                      ucSharedBuffer,
                                      xPacketSize );
   IotMqtt_Assert( xResult == IOT_MQTT_SUCCESS );
   // xMQTTSocket here is posix socket created and connected to MQTT broker outside of this function.
   xSentBytes = send( xMQTTSocket, ( void * ) ucSharedBuffer, xPacketSize, 0 );
   IotMqtt_Assert( xSentBytes == xPacketSize );
}