clFaultApi.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  : fault
 * File        : clFaultApi.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 *
 * This file provides the signature of clFaultNotifyRmd and the
 * default escalation function clFaultEscalate along with the
 * fault client library initialization and finalization
 * function prototypes.
 *
 *****************************************************************************/

/*********************************************************************************/
/************************** Fault Manager functions ***********************************/
/*********************************************************************************/
/*                                                                               */
/* clFaultReport                                                     */
/* clFaultRepairAction                                               */
/* clFaultSvcLibInitialize                                           */
/* clFaultSvcLibFinalize                                             */
/* clFaultVersionVerify                                              */
/*                                                                               */
/*********************************************************************************/


#ifndef _CL_FAULT_API_H_
#define _CL_FAULT_API_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <clCommon.h>
#include <clCorMetaData.h>
#include <clFaultDefinitions.h>
#include <clAmsClientNotification.h>

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


/******************************************************************************
 *   Function IDs for RMD calls
 ******************************************************************************/


/*****************************************************************************
 *  Functions
 *****************************************************************************/

extern 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);

extern ClRcT clFaultRepairAction(CL_IN ClIocAddressT iocAddress,
                                 CL_IN ClAlarmHandleT alarmHandle,
                                 CL_IN ClUint32T recoveryActionTaken);


extern ClRcT clFaultRepairNotification(ClAmsNotificationDescriptorT *notification,
                                       ClIocAddressT iocAddress,
                                       ClAlarmHandleT alarmHandle,
                                       ClUint32T recovery);

extern ClRcT clFaultSvcLibInitialize(void);


extern ClRcT clFaultSvcLibFinalize(void);


extern ClRcT clFaultVersionVerify( CL_INOUT ClVersionT *version);

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

#ifdef __cplusplus
}
#endif

#endif /* _CL_FAULT_API_H_ */