Get the size and Remaining Length of an MQTT CONNECT packet.

MQTTStatus_t MQTT_GetConnectPacketSize( const MQTTConnectInfo_t * pConnectInfo,
                                        const MQTTPublishInfo_t * pWillInfo,
                                        size_t * pRemainingLength,
                                        size_t * pPacketSize );

This function must be called before MQTT_SerializeConnect in order to get the size of the MQTT CONNECT packet that is generated from MQTTConnectInfo_t and optional MQTTPublishInfo_t. The size of the MQTTFixedBuffer_t supplied to MQTT_SerializeConnect must be at least pPacketSize. The provided pConnectInfo and pWillInfo are valid for serialization with MQTT_SerializeConnect only if this function returns MQTTSuccess. The remaining length returned in pRemainingLength and the packet size returned in pPacketSize are valid only if this function returns MQTTSuccess.

Parameters

[in]	pConnectInfo	MQTT CONNECT packet parameters.
[in]	pWillInfo	Last Will and Testament. Pass NULL if not used.
[out]	pRemainingLength	The Remaining Length of the MQTT CONNECT packet.
[out]	pPacketSize	The total size of the MQTT CONNECT packet.

Returns: MQTTBadParameter if the packet would exceed the size allowed by the MQTT spec; MQTTSuccess otherwise.

Example

// Variables used in this example.
MQTTStatus_t status;
MQTTConnectInfo_t connectInfo = { 0 };
MQTTPublishInfo_t willInfo = { 0 };
size_t remainingLength = 0, packetSize = 0;
 
// Initialize the connection info, the details are out of scope for this example.
initializeConnectInfo( &connectInfo );
 
// Initialize the optional will info, the details are out of scope for this example.
initializeWillInfo( &willInfo );
 
// Get the size requirement for the connect packet.
status = MQTT_GetConnectPacketSize(
     &connectInfo, &willInfo, &remainingLength, &packetSize
);
 
if( status == MQTTSuccess )
{
     // The application should allocate or use a static #MQTTFixedBuffer_t
     // of size >= packetSize to serialize the connect request.
}