OpenClovis Logo

clAlarmApi.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 : alarm
21  * File : clAlarmApi.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  *
27  * This module contains Alarm Service related APIs
28  *
29  *****************************************************************************/
30 
31 
32 #ifndef _CL_ALARM_API_H_
33 #define _CL_ALARM_API_H_
34 
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 
40 #include <clCommon.h>
41 #include <clAlarmDefinitions.h>
42 #include <clAlarmOMIpi.h>
43 
55 /******************************************************************************
56  * Constant and Macro Definitions
57  *****************************************************************************/
58 
59 
60 /*****************************************************************************
61  * Alarm Management functions
62  *****************************************************************************/
63 
91 
92 /********************************************************************/
93 
94 
121 
122 /********************************************************************/
123 
124 
176 
177 
203 ClRcT
205 
233 ClRcT
234 clAlarmEventDataGet(CL_IN ClUint8T *pData, CL_IN ClSizeT size, CL_OUT ClAlarmHandleInfoT *pAlarmHandleInfo);
235 
262 
297 ClRcT
299 
300 
329 ClRcT
331 
365 ClRcT
367  CL_OUT ClAlarmStateT * const pAlarmState);
368 
369 
415 ClRcT
417  CL_OUT ClAlarmPendingAlmListPtrT const pPendingAlmList);
418 
419 
447 ClRcT
449 /***************************************************************************/
450 
451 ClRcT clAlarmConfigDataGet(ClCorMOIdPtrT pMoId, ClAlarmInfoT** ppAlarmInfo, ClUint32T* pCount);
452 
453 ClRcT clAlarmReset(ClCorMOIdPtrT pMoId, VDECL_VER(ClAlarmIdT, 4, 1, 0)* pAlarmId, ClUint32T count);
454 
455 #ifdef __cplusplus
456 }
457 #endif
458 
459 #endif /* _CL_ALARM_API_H_ */
460 
Typical defines found in any software project.
Header File of Alarm related Definitions.
ClRcT clAlarmLibInitialize()
Initializes the Alarm Library.
ClUint32T ClAlarmHandleT
The type of the handle for identifying the raised alarm.
Definition: clAlarmDefinitions.h:131
ClRcT clAlarmEventDataGet(CL_IN ClUint8T *pData, CL_IN ClSizeT size, CL_OUT ClAlarmHandleInfoT *pAlarmHandleInfo)
This function is used to get the decoded data in host format of the alarm data obtained after receivi...
ClRcT clAlarmStateQuery(CL_IN const ClAlarmInfoT *pAlarmInfo, CL_OUT ClAlarmStateT *const pAlarmState)
\breif Function to get the current state of the alarm.
ClRcT clAlarmPendingAlarmListFree(CL_INOUT ClAlarmPendingAlmListPtrT const pPendingAlmList)
\breif Function to free the pending alarm list populated by clAlarmPendingAlarmsQuery.
ClRcT(* ClAlarmEventCallbackFuncPtrT)(CL_IN const ClAlarmHandleInfoT *pAlarmInfo)
Informs the consumer of the event about the events published by the alarm server.
Definition: clAlarmApi.h:261
ClRcT clAlarmEventUnsubscribe()
This function is used to unsubscribe for the events published by the alarm server.
ClRcT clAlarmPendingAlarmsQuery(CL_IN ClCorMOIdPtrT const pMoId, CL_OUT ClAlarmPendingAlmListPtrT const pPendingAlmList)
\breif Function to get the pending alarms on a specific object or in the whole system.
ClRcT clAlarmVersionVerify(CL_INOUT ClVersionT *pVersion)
This function is used to verify if a version of the function is supported by AM.
ClAlarmStateT
The enumeration to depict the state of the alarm that is into.
Definition: clAlarmDefinitions.h:509
ClRcT clAlarmLibFinalize()
Cleans up the Alarm Library.
ClRcT clAlarmRaise(CL_IN ClAlarmInfoT *pAlarmInfo, CL_OUT ClAlarmHandleT *pAlarmHandle)
Raises an alarm on a component.
ClRcT clAlarmEventSubscribe(CL_IN const ClAlarmEventCallbackFuncPtrT pAlarmEvtCallbackFuncFP)
This function is used to subscribe for the events published by the alarm server.
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_OUT
CL_OUT macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:110
ClUint64T ClSizeT
Definition: clCommon.h:157
#define CL_IN
CL_IN macro assists in clearly defining arguments of an API, but has no actual meaning.
Definition: clCommon.h:106
Version Information for various services.
Definition: clCommon.h:250
The ClAlarmInfoT data structure is used to store the entire list of alarm attributes that include pro...
Definition: clAlarmDefinitions.h:544
The ClAlarmHandleInfoT data structure is used to store the handle and the information of the alarm.
Definition: clAlarmDefinitions.h:612
Structure to contain the information about the pending alarms.
Definition: clAlarmDefinitions.h:821
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918

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