IoTHubModuleClient_SetModuleTwinCallback()

  • 2 minutes to read

This API specifies a call back to be used when the module receives a state update.

Syntax

#include "azure-iot-sdk-c/iothub_client/inc/iothub_module_client.h"

IOTHUB_CLIENT_RESULT IoTHubModuleClient_SetModuleTwinCallback(
  IOTHUB_MODULE_CLIENT_HANDLE         iotHubModuleClientHandle,
  IOTHUB_CLIENT_DEVICE_TWIN_CALLBACK  moduleTwinCallback,
  void *                              userContextCallback
);

Parameters

  • iotHubModuleClientHandle The handle created by a call to the create function.

  • moduleTwinCallback The callback specified by the module client to be used for updating the desired state. The callback will be called in response to a request send by the IoTHub services. The payload will be passed to the callback, along with two version numbers:

  • Desired:

  • LastSeenReported:

  • userContextCallback User specified context that will be provided to the callback. This can be NULL.

NOTE: The application behavior is undefined if the user calls the IoTHubModuleClient_Destroy function from within any callback.

Return Value

IOTHUB_CLIENT_OK upon success or an error code upon failure.