clAlarmUtils.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        : clAlarmUtils.h
 *******************************************************************************/

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

#ifndef _CL_ALARM_UTIL_H
#define _CL_ALARM_UTIL_H

#ifdef __cplusplus
extern "C" {
#endif
   
#include <clCommon.h>
#include <clCommonErrors.h>
#include <clCorMetaData.h>


typedef struct ClAlarmUtilTlv{
    ClCorTypeT  type;
    ClUint32T   length;
    ClPtrT      value;
}ClAlarmUtilTlvT;

typedef struct ClAlarmUtilTlv *ClAlarmUtilTlvPtrT;


typedef struct ClAlarmUtilTlvInfo{
    ClUint32T           numTlvs;
    ClAlarmUtilTlvPtrT  pTlv;
}ClAlarmUtilTlvInfoT;

typedef struct ClAlarmUtilTlvInfo *ClAlarmUtilTlvInfoPtrT;
    
typedef struct ClAlarmUtilPayLoad{
    ClCorMOIdPtrT       pMoId;
    ClUint32T           numTlvs;
    ClAlarmUtilTlvPtrT  pTlv;
}ClAlarmUtilPayLoadT;

typedef struct ClAlarmUtilPayLoad *ClAlarmUtilPayLoadPtrT;

typedef struct ClAlarmUtilPayLoadList
{
    ClUint32T               numPayLoadEnteries;
    ClAlarmUtilPayLoadPtrT  pPayload;
}ClAlarmUtilPayLoadListT;

typedef struct ClAlarmUtilPayLoadList *ClAlarmUtilPayLoadListPtrT;

ClRcT clAlarmUtilPayloadFlatten(ClAlarmUtilPayLoadListPtrT pPayLoadList, ClUint32T *pSize, ClUint8T  **ppBuf);

ClRcT clAlarmUtilPayLoadExtract(ClUint8T  *pBuf, ClUint32T size, ClAlarmUtilPayLoadListT **ppPayloadList);

void clAlarmUtilPayloadBufFree(ClUint8T  *pBuf);

void clAlarmUtilPayloadListFree(ClAlarmUtilPayLoadListT   *pPayloadList);


ClRcT 
clAlarmClientDebugRegister (CL_OUT ClHandleT * pAlarmDebugHandle);

ClRcT 
clAlarmClientDebugDeregister (CL_IN ClHandleT alarmDebugHandle);

#ifdef __cplusplus
}
#endif

#endif /*_CL_ALARM_UTIL_H */