OpenClovis Logo

clFaultApi.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 : fault
21  * File : clFaultApi.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  *
27  * This file provides the signature of clFaultNotifyRmd and the
28  * default escalation function clFaultEscalate along with the
29  * fault client library initialization and finalization
30  * function prototypes.
31  *
32  *****************************************************************************/
33 
34 /*********************************************************************************/
35 /************************** Fault Manager functions ***********************************/
36 /*********************************************************************************/
37 /* */
38 /* clFaultReport */
39 /* clFaultRepairAction */
40 /* clFaultSvcLibInitialize */
41 /* clFaultSvcLibFinalize */
42 /* clFaultVersionVerify */
43 /* */
44 /*********************************************************************************/
45 
46 
61 #ifndef _CL_FAULT_API_H_
62 #define _CL_FAULT_API_H_
63 
64 #ifdef __cplusplus
65 extern "C" {
66 #endif
67 
68 #include <clCommon.h>
69 #include <clCorMetaData.h>
70 #include <clFaultDefinitions.h>
71 #include <clAmsClientNotification.h>
72 
73 /******************************************************************************
74  * Constant and Macro Definitions
75  *****************************************************************************/
76 
77 
78 /******************************************************************************
79  * Function IDs for RMD calls
80  ******************************************************************************/
81 
82 
83 /*****************************************************************************
84  * Functions
85  *****************************************************************************/
86 
138 extern ClRcT clFaultReport(CL_IN ClNameT *compName,
139  CL_IN ClCorMOIdPtrT hMoId,
140  CL_IN ClAlarmStateT alarmState,
141  CL_IN ClAlarmCategoryTypeT category,
142  CL_IN ClAlarmSpecificProblemT specificProblem,
143  CL_IN ClAlarmSeverityTypeT severity,
145  CL_IN void *pData,
146  CL_IN ClUint32T len);
147 
176  CL_IN ClAlarmHandleT alarmHandle,
177  CL_IN ClUint32T recoveryActionTaken);
178 
179 
180 extern ClRcT clFaultRepairNotification(ClAmsNotificationDescriptorT *notification,
181  ClIocAddressT iocAddress,
182  ClAlarmHandleT alarmHandle,
183  ClUint32T recovery);
184 
208 
209 
233 
234 
259 
260 /***************************************************************************/
261 
262 #ifdef __cplusplus
263 }
264 #endif
265 
266 #endif /* _CL_FAULT_API_H_ */
267 
Typical defines found in any software project.
Header file of all MetaData data structures.
Header file of Definitions for the Fault record structure.
ClGmsClusterNotificationT * notification
Array of nodes.
Definition: clClmTmsCommon.h:13
ClUint32T ClAlarmHandleT
The type of the handle for identifying the raised alarm.
Definition: clAlarmDefinitions.h:131
ClAlarmProbableCauseT
This enumeration defines all the probable causes of the alarm based on the categories.
Definition: clAlarmDefinitions.h:189
ClAlarmStateT
The enumeration to depict the state of the alarm that is into.
Definition: clAlarmDefinitions.h:509
ClAlarmSeverityTypeT
Enumeration to depict the severity of the alarm which is specified while modeling and also while publ...
Definition: clAlarmDefinitions.h:142
ClUint32T ClAlarmSpecificProblemT
The type of an identifier to the specific problem of the alarm.
Definition: clAlarmDefinitions.h:126
ClAlarmCategoryTypeT
Enumeration defining the categories of alarms support by alarm server.
Definition: clAlarmDefinitions.h:81
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
ClRcT clFaultVersionVerify(CL_INOUT ClVersionT *version)
Verifies the version of the FM library supported by the FM.
ClRcT clFaultSvcLibInitialize(void)
Initializes the Fault Manager Library.
ClRcT clFaultSvcLibFinalize(void)
Cleans up the Fault Manager library and frees resources allocated to it.
ClRcT clFaultRepairAction(CL_IN ClIocAddressT iocAddress, CL_IN ClAlarmHandleT alarmHandle, CL_IN ClUint32T recoveryActionTaken)
Notifies fault to the "Fault service" for taking repair action.
ClRcT clFaultReport(CL_IN ClNameT *compName, CL_IN ClCorMOIdPtrT hMoId, CL_IN ClAlarmStateT alarmState, CL_IN ClAlarmCategoryTypeT category, CL_IN ClAlarmSpecificProblemT specificProblem, CL_IN ClAlarmSeverityTypeT severity, CL_IN ClAlarmProbableCauseT cause, CL_IN void *pData, CL_IN ClUint32T len)
Reports a fault to the Fault service.
A name.
Definition: clCommon.h:197
Version Information for various services.
Definition: clCommon.h:250
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918
IOC address.
Definition: clIocApi.h:401

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