clPMApi.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  : PM 
 * File        : clPMApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *          This header file contains PM API prototypes and structures.
 *
 *
 *****************************************************************************/

#ifndef _CL_PM_API_H_
#define _CL_PM_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clCommon.h>
#include <clOmObjectManage.h>
#include <clOmCommonClassTypes.h>
#include <clOmBaseClass.h>
#include <clCorApi.h>
#include <clCorNotifyApi.h>
#include <clAlarmDefinitions.h>
#include <clAlarmUtils.h>

typedef struct
{
    ClAlarmProbableCauseT probableCause;
    ClAlarmSpecificProblemT specificProblem;
    ClAlarmUtilPayLoadListPtrT pAlarmPayload;
}ClPMAlarmDataT;

typedef ClPMAlarmDataT* ClPMAlarmDataPtrT;

typedef struct
{
    ClCorAttrIdT attrId;

    ClCorAttrPathPtrT pAttrPath;

    ClCorAttrTypeT attrType;

    ClCorTypeT attrDataType;

    void* pPMData;

    ClUint32T size;

    ClInt32T index;

    ClUint32T alarmCount;

    ClPMAlarmDataPtrT pAlarmData;

} ClPMAttrDataT;


typedef ClPMAttrDataT* ClPMAttrDataPtrT;

typedef struct 
{
    ClCorMOIdPtrT pMoId;

    ClUint32T attrCount;

    ClPMAttrDataPtrT pAttrData;

} ClPMObjectDataT;

typedef ClPMObjectDataT* ClPMObjectDataPtrT;

typedef ClRcT (*ClPMObjectReadCallbackT)
                (CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData);

typedef ClRcT (*ClPMObjectResetCallbackT)
                (CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData);


typedef struct 
{
    ClPMObjectReadCallbackT fpPMObjectRead;
    ClPMObjectResetCallbackT fpPMObjectReset;
} ClPMCallbacksT;


ClRcT clPMStart(ClCorMOIdListPtrT pMoIdList);


ClRcT clPMStop(ClCorMOIdListPtrT pMoIdList);

ClRcT clPMResourcesGet(ClCorMOIdListT** ppMoIdList);

ClRcT clPMClientDebugRegister(ClHandleT* pDebugHandle);
ClRcT clPMClientDebugUnregister(ClHandleT debugHandle);

#ifdef __cplusplus
}
#endif

#endif /* _CL_PM_API_H_ */