Header file of Event Manager Related APIs. More...
#include "clCommon.h"#include "clCommonErrors.h"#include "clOsalApi.h"#include "clCntApi.h"#include "clEventErrors.h"Go to the source code of this file.
Classes | |
| struct | ClEventCallbacksT |
| The callback structure supplied by an EO to the EM containing the callback functions that can be invoked by the EM. More... | |
| struct | ClEventFilterArrayT |
| The event filter array structure defines one or more filters. More... | |
| struct | ClEventFilterT |
| The event filter structure defines the filter type and the filter pattern to be applied on an event pattern when filtering events on an event channel. More... | |
| struct | ClEventPatternArrayT |
| The type of an event pattern array. More... | |
| struct | ClEventPatternT |
| An Event pattern may contain a name (for example: a process name, checkpoint name, service instance name, and so on). More... | |
Macros | |
| #define | CL_EVENT_CHANNEL_CREATE (0x8) |
| Creates an event channel if it does not exist. | |
| #define | CL_EVENT_CHANNEL_PUBLISHER (0x4) |
| Opens an event channel for publishing events. | |
| #define | CL_EVENT_CHANNEL_SUBSCRIBER (0x2) |
| Opens an event channel for subscribing events. | |
| #define | CL_EVENT_GLOBAL_CHANNEL (0x1) |
| Opens a global event channel. | |
| #define | CL_EVENT_HIGHEST_PRIORITY (0x0) |
| Highest priority. | |
| #define | CL_EVENT_LOCAL_CHANNEL (0x0) |
| Opens a local event channel. | |
| #define | CL_EVENT_LOWEST_PRIORITY (0x3) |
| Lowest priority. | |
| #define | CL_EVENT_VERSION {(ClUint8T)'B', 0x1, 0x1} |
| Latest Supported SAF Version for Event Service. | |
Typedefs | |
| typedef ClHandleT | ClEventChannelHandleT |
| The type of a handle to an open event channel. | |
| typedef void(* | ClEventChannelOpenCallbackT )(ClInvocationT invocation, ClEventChannelHandleT channelHandle, ClRcT error) |
| Open channel callback. | |
| typedef ClUint8T | ClEventChannelOpenFlagsT |
| Event Channel open flag. | |
| typedef void(* | ClEventDeliverCallbackT )(ClEventSubscriptionIdT subscriptionId, ClEventHandleT eventHandle, ClSizeT eventDataSize) |
| Event delivery callback. | |
| typedef ClHandleT | ClEventHandleT |
| The type of a handle to an event. | |
| typedef ClUint64T | ClEventIdT |
| The type of an event identifier. | |
| typedef ClHandleT | ClEventInitHandleT |
| The type of the handle supplied by the EM to an EO during the initialization of the EM library. | |
| typedef ClUint8T | ClEventPriorityT |
Event priority type - it ranges from CL_EVENT_LOWEST_PRIORITY to CL_EVENT_HIGHEST_PRIORITY. | |
| typedef ClUint32T | ClEventSubscriptionIdT |
| The type of an identifier for a particular subscription by a particular EO on a particular event channel. | |
Enumerations | |
| enum | ClEventFilterTypeT { CL_EVENT_PREFIX_FILTER = 1, CL_EVENT_SUFFIX_FILTER = 2, CL_EVENT_EXACT_FILTER = 3, CL_EVENT_PASS_ALL_FILTER = 4 } |
| Filter Related Information. More... | |
Functions | |
| ClRcT | clEventAllocate (CL_IN ClEventChannelHandleT channelHandle, CL_OUT ClEventHandleT *pEventHandle) |
| Allocates an event header. | |
| ClRcT | clEventAttributesGet (CL_IN ClEventHandleT eventHandle, CL_IN ClEventPatternArrayT *pPatternArray, CL_OUT ClEventPriorityT *pPriority, CL_OUT ClTimeT *pRetentionTime, CL_OUT ClNameT *pPublisherName, CL_OUT ClTimeT *pPublishTime, CL_OUT ClEventIdT *pEventId) |
| Returns the event attributes. | |
| ClRcT | clEventAttributesSet (CL_IN ClEventHandleT eventHandle, CL_IN const ClEventPatternArrayT *pPatternArray, CL_IN ClEventPriorityT priority, CL_IN ClTimeT retentionTime, CL_IN const ClNameT *pPublisherName) |
| Sets the event attributes. | |
| ClRcT | clEventChannelClose (CL_IN ClEventChannelHandleT channelHandle) |
| Closes an event channel. | |
| ClRcT | clEventChannelOpen (CL_IN ClEventInitHandleT evtHandle, CL_IN const ClNameT *pEvtChannelName, CL_IN ClEventChannelOpenFlagsT evtChannelOpenFlag, CL_IN ClTimeT timeout, CL_OUT ClEventChannelHandleT *pChannelHandle) |
| Opens an event channel. | |
| ClRcT | clEventChannelOpenAsync (CL_IN ClEventInitHandleT evtHandle, CL_IN ClInvocationT invocation, CL_IN const ClNameT *pEvtChannelName, CL_IN ClEventChannelOpenFlagsT channelOpenFlags) |
| Opens an event channel asynchronously. | |
| ClRcT | clEventChannelUnlink (CL_IN ClEventInitHandleT evtHandle, CL_IN const ClNameT *pEvtChannelName) |
| Deletes an event channel. | |
| ClRcT | clEventCookieGet (CL_IN ClEventHandleT eventHandle, CL_OUT void **ppCookie) |
| Returns the cookie. | |
| ClRcT | clEventDataGet (CL_IN ClEventHandleT eventHandle, CL_INOUT void *pEventData, CL_INOUT ClSizeT *pEventDataSize) |
| Returns data associated with an earlier event. | |
| ClRcT | clEventDispatch (ClEventInitHandleT evtHandle, ClDispatchFlagsT dispatchFlags) |
| Invokes the pending callback in context of the EO. | |
| ClRcT | clEventFinalize (CL_IN ClEventInitHandleT evtHandle) |
| Finalizes EM library. | |
| ClRcT | clEventFree (CL_IN ClEventHandleT eventHandle) |
| Frees an event header. | |
| ClRcT | clEventInitialize (CL_OUT ClEventInitHandleT *pEvtHandle, CL_IN const ClEventCallbacksT *pEvtCallbacks, CL_INOUT ClVersionT *pVersion) |
| Initializes EM library. | |
| ClRcT | clEventPublish (CL_IN ClEventHandleT eventHandle, CL_IN const void *pEventData, CL_IN ClSizeT eventDataSize, CL_OUT ClEventIdT *pEventId) |
| Publishes an event. | |
| ClRcT | clEventSelectionObjectGet (ClEventInitHandleT evtHandle, ClSelectionObjectT *pSelectionObject) |
| Helps detect pending callbacks. | |
| ClRcT | clEventSubscribe (CL_IN ClEventChannelHandleT channelHandle, CL_IN const ClEventFilterArrayT *pFilters, CL_IN ClEventSubscriptionIdT subscriptionId, CL_IN void *pCookie) |
| Subscribes to an event identified by an event type (filter). | |
| ClRcT | clEventUnsubscribe (CL_IN ClEventChannelHandleT channelHandle, CL_IN ClEventSubscriptionIdT subscriptionId) |
| Unsubscribes from an event. | |
Header file of Event Manager Related APIs.