OpenClovis Logo

clCorNotifyApi.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 : cor
21  * File : clCorNotifyApi.h
22  *******************************************************************************/
23 
24 /*****************************************************************************
25  * Description :
26  *
27  * The files contains APIs for subscribing/unsubscribing to the events
28  * on a Managed Objects. and associated datastrucutes.
29  *
30  *
31  *****************************************************************************/
32 
33 /****************************************************************************************/
34 /******************************** COR APIs **********************************************/
35 /****************************************************************************************/
36 /* */
37 /* clCorEventSubscribe */
38 /* clCorEventUnsubscribe */
39 /* clCorNotifyEventToOperationGet < -- OBSOLETE -- > */
40 /* clCorNotifyEventToMoIdGet < -- OBSOLETE -- > */
41 /* clCorNotifyEventToAttrPathGet < -- OBSOLTE -- > */
42 /* clCorNotifyEventToTransactionHandleGet <CHGD TO> clCorEventToCorTxnIdGet */
43 /* */
44 /*****************************************************************************************/
45 
59 #ifndef _CL_COR_NOTIFY_API_H_
60 #define _CL_COR_NOTIFY_API_H_
61 
62 #ifdef __cplusplus
63 extern "C" {
64 #endif
65 
66 #include <clCommon.h>
67 #include <clEoApi.h>
68 #include <clEoConfigApi.h>
69 #include <clEventApi.h>
70 #include "clCorMetaData.h"
71 #include "clCorServiceId.h"
72 #include <clCorTxnApi.h>
73 
74 /******************************************************************************
75  * Constant and Macro Definitions
76  *****************************************************************************/
77 
78 /******************************************************************************
79  * Data Types
80  *****************************************************************************/
81 
85 typedef struct ClCorAttrList {
89  ClUint32T attrCnt;
90 
94  ClInt32T attr[1];
96 
101 
105 typedef struct ClCorMOIdList
106 {
110  ClUint32T moIdCnt;
111 
116 
118 
123 
127 typedef ClHandleT ClCorNotifyHandleT;
128 
129 
130 #define clCorEventName "COR_EVT_CHANNEL"
131 #define CL_COR_EVT_CHANGE_NOTIFICATION 0x1
132 
133 /* This is an IPI which is only used by alarm client to susbscribe for multiple moIds. */
134 extern ClRcT
135 clCorMOListEventSubscribe(ClEventChannelHandleT channelHandle,
136  ClCorMOIdListPtrT pMoIdList,
137  ClCorAttrPathPtrT pAttrPath,
138  ClCorAttrListPtrT pAttrList,
139  ClCorOpsT ops,
140  void* cookie,
141  ClEventSubscriptionIdT subscriptionID);
142 
208  ClCorMOIdPtrT changedObj,
209  ClCorAttrPathPtrT pAttrPath,
210  ClCorAttrListPtrT attrList,
211  ClCorOpsT flags,
212  void * cookie,
213  ClEventSubscriptionIdT subscriptionId);
248 
286 extern ClRcT
288 
289 #ifdef __cplusplus
290 }
291 #endif
292 
293 #endif /* _CL_COR_NOTIFY_API_H_ */
294 
Typical defines found in any software project.
Header file of all MetaData data structures.
Header file of COR Service Ids.
Header file of Transaction related APIs for COR.
Header file of EO related APIs.
Header file of EO Config Definitions.
Header file of Event Manager Related APIs.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
ClUint64T ClSizeT
Definition: clCommon.h:157
ClPtrT ClCorTxnIdT
The type of the COR transaction ID used to identify a transaction session.
Definition: clCorMetaData.h:642
ClRcT clCorEventUnsubscribe(ClEventChannelHandleT channelHandle, ClEventSubscriptionIdT subscriptionId)
Unsubscribes for attribute change notification.
ClCorOpsT
The values of the ClCorOpsT enumeration type contain the Operation IDs.
Definition: clCorMetaData.h:653
ClCorAttrListT * ClCorAttrListPtrT
Pointer type to ClCorAttrListT.
Definition: clCorNotifyApi.h:100
ClRcT clCorEventSubscribe(ClEventChannelHandleT channelHandle, ClCorMOIdPtrT changedObj, ClCorAttrPathPtrT pAttrPath, ClCorAttrListPtrT attrList, ClCorOpsT flags, void *cookie, ClEventSubscriptionIdT subscriptionId)
Subscribes for notifications when a change occurs in an attribute.
ClHandleT ClCorNotifyHandleT
COR notify handle, return by subscribe, used for unsubscribing.
Definition: clCorNotifyApi.h:127
ClRcT clCorEventHandleToCorTxnIdGet(ClEventHandleT evtH, ClSizeT size, ClCorTxnIdT *corTxnId)
struct ClCorMOIdList ClCorMOIdListT
Type to store the list of MoIds.
struct ClCorAttrList ClCorAttrListT
Type to store the list of attributes.
ClCorMOIdListT * ClCorMOIdListPtrT
Pointer type to ClCorMOIdListT.
Definition: clCorNotifyApi.h:122
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
ClHandleT ClEventHandleT
The type of a handle to an event.
Definition: clEventApi.h:158
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918
The structure ClCorAttrPath contains the path-list of the attribute.
Definition: clCorMetaData.h:997
Type to store the list of attributes.
Definition: clCorNotifyApi.h:85
ClUint32T attrCnt
Number of attributes.
Definition: clCorNotifyApi.h:89
ClInt32T attr[1]
List of attributes.
Definition: clCorNotifyApi.h:94
Type to store the list of MoIds.
Definition: clCorNotifyApi.h:106
ClCorMOIdT moId[1]
List of MoIds.
Definition: clCorNotifyApi.h:115
ClUint32T moIdCnt
Number of MoIds.
Definition: clCorNotifyApi.h:110

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