Sebastián Pastor / EtheriosCloudConnector
Embed: (wiki syntax)

« Back to documentation index

Application-defined callback

Application-defined callback

Include: connector_api.h More...

Typedefs

typedef
connector_callback_status_t(* 
connector_callback_t )(connector_class_id_t const class_id, connector_request_id_t const request_id, void *const data)

Detailed Description

Include: connector_api.h

This is Cloud Connector Application defined callback.

An application must define this function and pass this to Connector during the connector_init() call. This callback is used to pass configuration data and exchange system services with the Connector state machine. The callback return value is then used to guide Connector how to proceed after completion of the application callback.


Typedef Documentation

typedef connector_callback_status_t(* connector_callback_t)(connector_class_id_t const class_id, connector_request_id_t const request_id, void *const data)
Parameters:
class_idThis is a grouping or category of callback functions. Each class_id contains a number of related request_id's.
request_idThe request ID defines the specific callback being requested.
dataPoints to specific structure for a given class ID and request ID
Return values:
connector_callback_continueThe callback completed successfully and Cloud Connector should continue it's process.
connector_callback_busyThe callback could not complete the operation within the allowable time frame. Do not advance the Cloud Connector state and recall this callback at some later time.
connector_callback_errorAn application level error occurred while processing the callback.
connector_callback_abortThe application is requesting Cloud Connector to abort execution. This will cause connector_run() or connector_step() to terminate with status connector_abort.
connector_callback_unrecognizedAn unsupported and unrecognized callback was received. The application does not support this request. This should be implemented in the application to allow for graceful recovery and upgrade-ability to future Cloud Connector releases.
See also:
connector_callback_status_t
connector_init()

Definition at line 529 of file connector_api.h.