clAlarmApi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : alarm
 * File        : clAlarmApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 * This module contains Alarm Service related APIs
 *
 *****************************************************************************/


#ifndef _CL_ALARM_API_H_
#define _CL_ALARM_API_H_

#ifdef __cplusplus
extern "C" {
#endif


#include <clCommon.h>
#include <clAlarmDefinitions.h>
#include <clAlarmOMIpi.h>

/******************************************************************************
 *  Constant and Macro Definitions
 *****************************************************************************/


/*****************************************************************************
 *  Alarm Management functions
 *****************************************************************************/
 
ClRcT clAlarmLibInitialize();

/********************************************************************/


ClRcT clAlarmLibFinalize();

/********************************************************************/


ClRcT clAlarmRaise(CL_IN ClAlarmInfoT* pAlarmInfo,CL_OUT ClAlarmHandleT *pAlarmHandle);


ClRcT
clAlarmVersionVerify( CL_INOUT ClVersionT *pVersion);

ClRcT
clAlarmEventDataGet(CL_IN ClUint8T *pData, CL_IN ClSizeT size, CL_OUT ClAlarmHandleInfoT *pAlarmHandleInfo);

typedef ClRcT (*ClAlarmEventCallbackFuncPtrT) (CL_IN const ClAlarmHandleInfoT* pAlarmInfo);

ClRcT
clAlarmEventSubscribe( CL_IN const ClAlarmEventCallbackFuncPtrT pAlarmEvtCallbackFuncFP);


ClRcT 
clAlarmEventUnsubscribe();

ClRcT 
clAlarmStateQuery (CL_IN const ClAlarmInfoT *pAlarmInfo,
                   CL_OUT ClAlarmStateT * const pAlarmState);


ClRcT 
clAlarmPendingAlarmsQuery (CL_IN ClCorMOIdPtrT const pMoId, 
                           CL_OUT ClAlarmPendingAlmListPtrT const pPendingAlmList);


ClRcT
clAlarmPendingAlarmListFree(CL_INOUT ClAlarmPendingAlmListPtrT const pPendingAlmList);
/***************************************************************************/

ClRcT clAlarmConfigDataGet(ClCorMOIdPtrT pMoId, ClAlarmInfoT** ppAlarmInfo, ClUint32T* pCount);

ClRcT clAlarmReset(ClCorMOIdPtrT pMoId, VDECL_VER(ClAlarmIdT, 4, 1, 0)* pAlarmId, ClUint32T count);

#ifdef __cplusplus
}
#endif

#endif /* _CL_ALARM_API_H_ */