OpenClovis Logo

clPMApi.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 : PM
21  * File : clPMApi.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  * This header file contains PM API prototypes and structures.
27  *
28  *
29  *****************************************************************************/
30 
31 #ifndef _CL_PM_API_H_
32 #define _CL_PM_API_H_
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 #include <clCommon.h>
39 #include <clOmObjectManage.h>
40 #include <clOmCommonClassTypes.h>
41 #include <clOmBaseClass.h>
42 #include <clCorApi.h>
43 #include <clCorNotifyApi.h>
44 #include <clAlarmDefinitions.h>
45 #include <clAlarmUtils.h>
46 
58 typedef struct
59 {
60  ClAlarmProbableCauseT probableCause;
61  ClAlarmSpecificProblemT specificProblem;
62  ClAlarmUtilPayLoadListPtrT pAlarmPayload;
63 }ClPMAlarmDataT;
64 
65 typedef ClPMAlarmDataT* ClPMAlarmDataPtrT;
66 
71 typedef struct
72 {
77 
83 
90 
95 
102  void* pPMData;
103 
107  ClUint32T size;
108 
113  ClInt32T index;
114 
115  ClUint32T alarmCount;
116 
117  ClPMAlarmDataPtrT pAlarmData;
118 
119 } ClPMAttrDataT;
120 
121 
126 
133 typedef struct
134 {
139 
143  ClUint32T attrCount;
144 
150 
152 
157 
184  (CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData);
185 
211  (CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData);
212 
213 
217 typedef struct
218 {
219  ClPMObjectReadCallbackT fpPMObjectRead;
220  ClPMObjectResetCallbackT fpPMObjectReset;
222 
223 
250 
251 
277 
278 ClRcT clPMResourcesGet(ClCorMOIdListT** ppMoIdList);
279 
280 ClRcT clPMClientDebugRegister(ClHandleT* pDebugHandle);
281 ClRcT clPMClientDebugUnregister(ClHandleT debugHandle);
282 
285 #ifdef __cplusplus
286 }
287 #endif
288 
289 #endif /* _CL_PM_API_H_ */
Typical defines found in any software project.
Header File of Alarm related Definitions.
Header File containing functions and structures used for alarm payload for traps.
Header file of Clovis Object Registry (COR) related APIs.
Header file of COR APIs for subscribing/unsubscribing to the events on a Managed Objects.
ClAlarmProbableCauseT
This enumeration defines all the probable causes of the alarm based on the categories.
Definition: clAlarmDefinitions.h:189
ClUint32T ClAlarmSpecificProblemT
The type of an identifier to the specific problem of the alarm.
Definition: clAlarmDefinitions.h:126
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
#define CL_INOUT
CL_INOUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:108
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
enum ClCorType ClCorTypeT
The ClCorType enumeration contains the basic COR data types.
enum ClCorAttrType ClCorAttrTypeT
The values of this enumeration type refer to the COR attribute types.
ClInt32T ClCorAttrIdT
The type of an identifier for a COR attribute.
Definition: clCorMetaData.h:206
ClPMObjectDataT * ClPMObjectDataPtrT
Pointer type for ClPMObjectDataPtrT.
Definition: clPMApi.h:156
ClRcT clPMStart(ClCorMOIdListPtrT pMoIdList)
Starts the PM operation on the list of MO Ids passed.
ClRcT(* ClPMObjectReadCallbackT)(CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData)
Callback used to read the value of PM attributes.
Definition: clPMApi.h:184
ClRcT clPMStop(ClCorMOIdListPtrT pMoIdList)
Stops the PM operation on the list of MO Ids passed.
ClRcT(* ClPMObjectResetCallbackT)(CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData)
Callback used to reset the value of PM attributes.
Definition: clPMApi.h:211
ClPMAttrDataT * ClPMAttrDataPtrT
Pointer type for ClPMAttrDataT.
Definition: clPMApi.h:125
The stucture is used to specify the alarm payload information.
Definition: clAlarmUtils.h:156
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 MoIds.
Definition: clCorNotifyApi.h:106
This is used to pass PM and PM reset attributes information to the Primary OI.
Definition: clPMApi.h:72
ClCorTypeT attrDataType
This contains the actual datatype of the attribute.
Definition: clPMApi.h:94
ClCorAttrIdT attrId
Attribute Id of PM or PM reset attribute.
Definition: clPMApi.h:76
ClCorAttrPathPtrT pAttrPath
Attribute Path.
Definition: clPMApi.h:82
ClUint32T size
Size of the attribute.
Definition: clPMApi.h:107
ClCorAttrTypeT attrType
Type of the attribtute.
Definition: clPMApi.h:89
void * pPMData
This contains the PM reset attribute's value if it is reset from north-bound, or the Primary OI shoul...
Definition: clPMApi.h:102
ClInt32T index
Index of the attribute.
Definition: clPMApi.h:113
This is used to pass the PM object's values to the Primary OI.
Definition: clPMApi.h:134
ClPMAttrDataPtrT pAttrData
This either contains the PM attributes' info or PM reset attributes' info and value.
Definition: clPMApi.h:149
ClCorMOIdPtrT pMoId
The PM Object Identifier.
Definition: clPMApi.h:138
ClUint32T attrCount
This contains the no.
Definition: clPMApi.h:143
This stores address of the PM callback functions implemented by Primary OI.
Definition: clPMApi.h:218

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