CHAILink SDK  Version 1.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
CLC_Callbacks Struct Reference

Structure containing all CHAILink client callbacks. More...

#include <CLC_Callbacks.h>

Data Fields

CLC_Application_CallbackList Application
 A CLC_Application_CallbackList structure filled by application and containing the list of application callbacks. More...
 
CLC_ARH_CallbackList const * pARHCallbackList
 Pointer to a :CLC_ARH_CallbackList structure provided by application and containing the list of all asynchronous returns. More...
 
CLC_NH_CallbackList const * pNHCallbackList
 Pointer to a :CLC_NH_CallbackList structure provided by application and containing the list of all notification handlers. More...
 

Detailed Description

Structure containing all CHAILink client callbacks.

This structure is passed to CLC_Init during initialization and it contains all callbacks that the application needs. A sample implementation of this structure can be found at the end of the CLC_Callbacks.h file. There is 3 categories of callback:

  • Application callbacks. It contains callbacks for application notification (APP_ERRORCB and APP_CONNECTIONSTATECHANGE) and pointers for the two tasks, the CopperLan task (APP_COPPERLANDOPROCESS) and the system task (APP_SYSTEMDOPROCESS). It also contains application defined parameters for each task.
  • Asynchronous Returns callbacks. It contains callback functions corresponding to Asynchronous Return call for CHAI or Remote Device objects. if ENABLE_NETWORK_SEARCH nor ENABLE_REMOTE_DEVICE are defined in your customization file (CLC_Customization.h), pARHCallbackList field does not exist in the structure.
  • Notification callbacks. It contains callback functions corresponding to all object notifications. Use xxx_RegisterNotificationHandler functions to activate these notifications. Both ARH and NH callback lists are const pointer in order to optimize memory usage. By doing this, linker can put these structures in ROM if needed.

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