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

/*******************************************************************************
 * Description :
 *
 * This file provides the definitions for the fault record structure.
 *
 *****************************************************************************/

#ifndef _CL_FAULT_DEFINITIONS_H_
#define _CL_FAULT_DEFINITIONS_H_

#ifdef __cplusplus
extern "C" {
#endif

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


typedef struct ClFaultEvent {

    ClUint32T version;

    ClNameT compName;

    ClCorMOIdT  moId;

    ClAlarmStateT alarmState;
                
    ClAlarmCategoryTypeT category;

    ClAlarmSeverityTypeT severity;

    ClUint32T timeStamp;      

    ClAlarmProbableCauseT cause;      

    ClAlarmSpecificProblemT specificProblem;

    ClUint32T recoveryActionTaken;    

    ClUint32T addInfoLen;

    ClInt8T additionalInfo[1];
} ClFaultEventT;

typedef ClFaultEventT*    ClFaultEventPtr;

typedef struct ClFaultRecord {

    ClUint8T    seqNum;

    ClFaultEventT   event;
} ClFaultRecordT;

typedef ClFaultRecordT*    ClFaultRecordPtr;

typedef ClRcT (*ClFaultSeqTblT) (ClFaultRecordPtr hRec);


#ifdef __cplusplus
}
#endif

#endif                           /* _CL_FAULT_DEFINITIONS_H_ */