FreeRTOS
Data Fields
ShadowCallbackParams Struct Reference

Parameters to SHADOW_RegisterCallbacks. More...

#include <aws_shadow.h>

Data Fields

const char * pcThingName
 Thing Name for which callbacks are registered.
 
ShadowUpdatedCallback_t xShadowUpdatedCallback
 Called to notify users that a Thing Shadow has been updated. More...
 
ShadowDeletedCallback_t xShadowDeletedCallback
 Called to notify users that another client has deleted the Thing Shadow. More...
 
ShadowDeltaCallback_t xShadowDeltaCallback
 Called to notify users that a delta document has been generated. More...
 

Detailed Description

Parameters to SHADOW_RegisterCallbacks.

Definition at line 273 of file aws_shadow.h.

Field Documentation

◆ xShadowDeletedCallback

ShadowDeletedCallback_t xShadowDeletedCallback

Called to notify users that another client has deleted the Thing Shadow.

Callback for a message on /delete/accepted. Set to NULL for no callback.

Note
This function will not be called if the same Shadow Client that registered the callback function deleted the Thing Shadow.

Definition at line 292 of file aws_shadow.h.

◆ xShadowDeltaCallback

ShadowDeltaCallback_t xShadowDeltaCallback

Called to notify users that a delta document has been generated.

Callback for a message on /delete/accepted. Set to NULL for no callback.

Note
This function will be called whenever a delta document is generated, regardless of which client performed an update.

Definition at line 300 of file aws_shadow.h.

◆ xShadowUpdatedCallback

ShadowUpdatedCallback_t xShadowUpdatedCallback

Called to notify users that a Thing Shadow has been updated.

Callback for a message on /update/documents. Set to NULL for no callback.

Note
This function will be called if the same Shadow Client that registered the callback function updated the Thing Shadow.

Definition at line 284 of file aws_shadow.h.


The documentation for this struct was generated from the following file: