OpenClovis Logo

clEventExtApi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2002-2012 OpenClovis Solutions Inc. All Rights Reserved.
3  *
4  * This file is available under a commercial license from the
5  * copyright holder or the GNU General Public License Version 2.0.
6  *
7  * The source code for this program is not published or otherwise
8  * divested of its trade secrets, irrespective of what has been
9  * deposited with the U.S. Copyright office.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * For more information, see the file COPYING provided with this
17  * material.
18  */
19 /*******************************************************************************
20  * ModuleName : event
21  * File : clEventExtApi.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  *
27  *
28  *****************************************************************************/
29 
43 #ifndef _CL_EVENT_EXT_API_H_
44 # define _CL_EVENT_EXT_API_H_
45 
46 
47 # ifdef __cplusplus
48 extern "C"
49 {
50 # endif
51 
52 # include "clCommon.h"
53 # include "clCommonErrors.h"
54 # include "clOsalApi.h"
55 # include "clCntApi.h"
56 # include "clCommon.h"
57 # include "clEventErrors.h"
58 # include "clEventApi.h"
59 
63 # define CL_EVENT_NON_ZERO_MATCH CL_EVENT_PASS_ALL_FILTER+1
64 
65 /*******************************************************************************
66 NOTE:-
67  The following table depicts the mapping between the normal and wrapper API.
68  The wrapper API is obtained by inserting 'Ext' in the corresponding API.
69 
70  clEventSubscribe - clEventExtSubscribe
71  clEvtEventAttributeSet - clEvtEventExtAttributeSet
72  clEvtEventAttributeGet - clEvtEventExtAttributeGet
73 *******************************************************************************/
74 
131  CL_IN ClUint32T eventType,
132  CL_IN ClEventSubscriptionIdT subscriptionId,
133  CL_IN void *pCookie);
134 
135 
136 
137 
138 
201  channelHandle, CL_IN ClRuleExprT *pRbeExpr,
203  subscriptionID, CL_IN void *pCookie);
204 
205 
206 
207 
208 
242  CL_IN ClUint32T eventType,
243  CL_IN ClEventPriorityT priority,
244  CL_IN ClTimeT retentionTime,
245  CL_IN const ClNameT *pPublisherName);
246 
247 
248 
298  CL_OUT ClUint32T *pEventType,
299  CL_OUT ClEventPriorityT * pPriority,
300  CL_OUT ClTimeT *pRetentionTime,
301  CL_OUT ClNameT *pPublisherName,
302  CL_OUT ClTimeT *pPublishTime,
303  CL_OUT ClEventIdT * pEventId);
304 
305 
306 # ifdef __cplusplus
307 }
308 # endif
309 
310 
311 #endif /* _CL_EVENT_EXT_API_H_ */
312 
Typical defines found in any software project.
Common Error Codes shared across multiple Clovis ASP Components.
Header file of Clovis Container Related APIs.
Header file of Event Manager Related APIs.
Header file of Event Manager Error Codes.
Operating System Abstraction Layer API.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
ClInt64T ClTimeT
Time duration specified in nanoseconds.
Definition: clCommon.h:154
#define CL_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
ClUint8T ClEventPriorityT
Event priority type - it ranges from CL_EVENT_LOWEST_PRIORITY to CL_EVENT_HIGHEST_PRIORITY.
Definition: clEventApi.h:121
ClHandleT ClEventChannelHandleT
The type of a handle to an open event channel.
Definition: clEventApi.h:164
ClUint32T ClEventSubscriptionIdT
The type of an identifier for a particular subscription by a particular EO on a particular event chan...
Definition: clEventApi.h:171
ClRcT clEventExtAttributesSet(CL_IN ClEventHandleT eventHandle, CL_IN ClUint32T eventType, CL_IN ClEventPriorityT priority, CL_IN ClTimeT retentionTime, CL_IN const ClNameT *pPublisherName)
Sets event attributes.
ClRcT clEventExtAttributesGet(CL_IN ClEventHandleT eventHandle, CL_OUT ClUint32T *pEventType, CL_OUT ClEventPriorityT *pPriority, CL_OUT ClTimeT *pRetentionTime, CL_OUT ClNameT *pPublisherName, CL_OUT ClTimeT *pPublishTime, CL_OUT ClEventIdT *pEventId)
Returns event attributes designated by eventHandle.
ClRcT clEventExtSubscribe(CL_IN ClEventChannelHandleT channelHandle, CL_IN ClUint32T eventType, CL_IN ClEventSubscriptionIdT subscriptionId, CL_IN void *pCookie)
Subscribes to an event identified by event type (constant integer instead of filter).
ClRcT clEventExtWithRbeSubscribe(CL_IN const ClEventChannelHandleT channelHandle, CL_IN ClRuleExprT *pRbeExpr, CL_IN ClEventSubscriptionIdT subscriptionID, CL_IN void *pCookie)
Subscribes to an event identified by an RBE.
ClUint64T ClEventIdT
The type of an event identifier.
Definition: clEventApi.h:115
ClHandleT ClEventHandleT
The type of a handle to an event.
Definition: clEventApi.h:158
A name.
Definition: clCommon.h:197
Rule to filter data.Expression definition.
Definition: clRuleApi.h:241

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen