Defender_MatchTopic

Check if the given topic is one of the Device Defender topics.

DefenderStatus_t Defender_MatchTopic( const char * pTopic,
                                      uint16_t topicLength,
                                      DefenderTopic_t * pOutApi,
                                      const char ** ppOutThingName,
                                      uint16_t * pOutThingNameLength );

The function outputs which API the topic is for. It also optionally outputs the starting location and length of the thing name in the given topic.

Parameters

[in]	pTopic	The topic string to check.
[in]	topicLength	The length of the topic string.
[out]	pOutApi	The defender topic API value.
[out]	ppOutThingName	Optional parameter to output the beginning of the thing name in the topic string. Pass NULL if not needed.
[out]	pOutThingNameLength	Optional parameter to output the length of the thing name in the topic string. Pass NULL if not needed.

Returns

DefenderSuccess if the topic is one of the defender topics; DefenderBadParameter if invalid parameters are passed; DefenderNoMatch if the topic is NOT one of the defender topics (parameter pOutApi gets DefenderInvalidTopic).

Example

// The following example shows how to use the Defender_MatchTopic API to
// check if an incoming MQTT publish message is a Device Defender message.
 
DefenderTopic_t api;
DefenderStatus_t status = DefenderSuccess;
 
// pTopic and topicLength are the topic string and length of the topic on
// which the publish message is received. These are usually provided by the
// MQTT client used. We pass the last two argument as NULL as we are not
// interested in the thing name in the topic string.
status = Defender_MatchTopic( pTopic,
                              topicLength,
                              &( api ),
                              NULL,
                              NULL );
 
if( status == DefenderSuccess )
{
     if( api == DefenderJsonReportAccepted )
     {
         // The published JSON report was accepted by the AWS IoT Device
         // Defender service. You can parse the response using your choice
         // of JSON parser and ensure that the report Id is same as was sent
         // in the defender report.
     }
     else if( api == DefenderJsonReportRejected )
     {
         // The published JSON report was rejected by the AWS IoT Device
         // Defender service.
     }
     else
     {
         // Unexpected response.
     }
}