Header file of EO Config Definitions. More...
#include <clCommon.h>Go to the source code of this file.
Classes | |
| struct | ClEoConfigT |
| This structure is passed during the clEoCreate API and contains the EO related configuration parameters. More... | |
| struct | ClEoSchedFeedBackT |
| Feedback sent by the software component being polled in response of heartbeat [is-Alive]. More... | |
Macros | |
| #define | CL_EO_DEFAULT_NAME "3RD_PARTY_COMP" |
| Default name of the Execution Object in case EO doesn't provide any name. | |
| #define | CL_EO_DEFAULT_THREADS 1 |
| Default number of threads required for an EO. | |
| #define | CL_EO_MAX_NAME_LEN 32 |
| Maximum length of the name of the EO. | |
| #define | CL_EO_NAME clEoNameGet() |
| Gives the name of the Execution Object. | |
Typedefs | |
| typedef ClRcT(* | ClEoAppCreateCallbackT )(CL_IN ClUint32T argc, CL_IN char *argv[]) |
| The application should initialize itself in this function callback. | |
| typedef ClRcT(* | ClEoAppDeleteCallbackT )() |
| The application performs cleanup in this function callback. | |
| typedef ClRcT(* | ClEoAppHealthCheckCallbackT )(CL_OUT ClEoSchedFeedBackT *schFeedback) |
| The application checks the health status in this function callback. | |
| typedef ClRcT(* | ClEoAppStateChgCallbackT )(CL_IN ClEoStateT state) |
| The application should change the state the service it is providing. | |
| typedef ClRcT(* | ClEoCustomActionT )(ClCompIdT compId, ClWaterMarkIdT wmId, ClWaterMarkT *pWaterMark, ClEoWaterMarkFlagT wmType, ClEoActionArgListT argList) |
| The application performs custom action in this callback. | |
| typedef ClUint64T | ClEoIdT |
| The type of the EOId, assigned to an EO as part of registration to the Component Manager. | |
Enumerations | |
| enum | ClEoApplicationTypeT { CL_EO_USE_THREAD_FOR_RECV = CL_TRUE, CL_EO_USE_THREAD_FOR_APP = CL_FALSE } |
| enum | ClEoPollingTypeT { CL_EO_DONT_POLL = 0, CL_EO_BUSY_POLL = 1, CL_EO_DEFAULT_POLL = 2 } |
| enum | ClEoStateT { CL_EO_STATE_INIT = 0x1, CL_EO_STATE_ACTIVE = 0x2, CL_EO_STATE_STDBY = 0x4, CL_EO_STATE_SUSPEND = 0x8, CL_EO_STATE_STOP = 0x10, CL_EO_STATE_KILL = 0x20, CL_EO_STATE_RESUME = 0x40, CL_EO_STATE_FAILED = 0x80, CL_EO_STATE_THREAD_SAFE = 0x100, CL_EO_STATE_BITS = 9 } |
| This is the EO state enumeration. More... | |
Functions | |
| ClCharT * | clEoNameGet (void) |
| Gives the name of the EO. | |
| ClRcT | clEoProgNameGet (ClCharT *pName, ClUint32T maxSize) |
| Gives the name of the executable for the EO. | |
Header file of EO Config Definitions.