mms_pevn.h

ICCP Toolkit 是在 Tru64下开发Tase.2通信协议的开发包

/************************************************************************/
/* SISCO SOFTWARE MODULE HEADER *****************************************/
/************************************************************************/
/*   (c) Copyright Systems Integration Specialists Company, Inc.,	*/
/*      	  1986 - 1997, All Rights Reserved.		        */
/*									*/
/* MODULE NAME : mms_pevn.h						*/
/* PRODUCT(S)  : MMSEASE						*/
/*									*/
/* MODULE DESCRIPTION : 						*/
/*	This file has the data structures and function definitions	*/
/*	required to interface with MMS event management services	*/
/*	at the primitive level.	     					*/
/*									*/
/*	Parameters : In general, the first parameter is the channel	*/
/*		     that the request or response is to be sent over.	*/
/*		     For Responses, the second parameter is the Invoke	*/
/*		     ID to be used. The last parameter is used to pass	*/
/*		     operation specific information by pointer. 	*/
/*									*/
/*	Return								*/
/*	    Values : Request functions return a pointer to the pending	*/
/*		     request tracking structure, of type MMSREQ_PEND.	*/
/*		     In case of error, the pointer is returned == 0	*/
/*		     and mms_op_err is written with the err code.	*/
/*		     Response functions return 0 if OK, else an error	*/
/*		     code.						*/
/*									*/
/* MODIFICATION LOG :							*/
/*  Date     Who   Rev			Comments			*/
/* --------  ---  ------   -------------------------------------------	*/
/* 07/15/97  MDE     02    Added cur_state defines			*/
/* 08/14/97  RKR     01    Format changes				*/
/* 04/02/97  DTL   7.00    MMSEASE 7.0 release. See MODL70.DOC for	*/
/*			   history.					*/
/************************************************************************/

#ifndef MMS_PEVN_INCLUDED
#define MMS_PEVN_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif

#include "mms_pvar.h"	/* needed for variable specification defs	*/
#include "mms_err.h"	/* needed for service error definitions		*/
#include "mms_mp.h"


/************************************************************************/
/* Event cur_state defines */

#define EC_STATE_DISABLED		0
#define EC_STATE_IDLE			1
#define EC_STATE_ACTIVE			2

#define EC_STATE_ACTIVE_NOACK_A  	3 
#define EC_STATE_IDLE_NOACK_I 		4 
#define EC_STATE_IDLE_NOACK_A		5 
#define EC_STATE_IDLE_ACKED     	6 
#define EC_STATE_ACTIVE_ACKED 		7 

/************************************************************************/
/* EVENT MANAGEMENT FUNCTIONS						*/
/************************************************************************/
/* The structures below are used to pass EVENT MANAGEMENT operation	*/
/* information to/from the MMS primitives.				*/
/************************************************************************/

struct event_enrollment
  {
  OBJECT_NAME evenroll_name;		/* event enrollment name 	*/
  ST_CHAR     evcon_name_tag;		/* 0 : event condition name	*/
					/* 1 : undefined		*/
  OBJECT_NAME evcon_name;		/* event condition name - for 	*/
					/* evcon_name_tag = 0 only	*/
  ST_BOOLEAN  evact_name_pres;		/* event action name present	*/
  ST_CHAR     evact_name_tag;		/* 0 : event action name	*/
					/* 1 : undefined		*/
  OBJECT_NAME evact_name;		/* event action name - for 	*/
	      				/* evact_name_tag = 0 only	*/
  ST_BOOLEAN  client_app_pres;		/* client application present	*/
  ST_INT      client_app_len;		/* client application length	*/
  ST_UCHAR    *client_app;		/* client application reference	*/
  ST_BOOLEAN  mms_deletable;		/* mms deletable (def = false)	*/
  ST_INT16    ee_class;			/* event enrollment class:	*/
    					/*   0 - modifier		*/
    					/*   1 - notification		*/
  ST_INT16    duration;			/* duration:			*/
    					/*   0 - current (default)	*/
    					/*   1 - permanent		*/
  ST_BOOLEAN  invoke_id_pres;		/* invoke id present		*/
  ST_UINT32   invoke_id;		/* invoke id 			*/
  ST_BOOLEAN  rem_acc_delay_pres;	/* rem acceptable delay present	*/
  ST_UINT32   rem_acc_delay;		/* remaining acceptable delay	*/
  ST_BOOLEAN  addl_detail_pres;		/* additional detail present	*/
  ST_INT      addl_detail_len;		/* length of additional detail	*/
  ST_UCHAR    *addl_detail;		/* pointer to additional detail */
  ST_BOOLEAN  ackec_name_pres;		/* ack event cond name present	*/
  ST_CHAR     ackec_name_tag;		/* 0 : ack event condition name	*/
					/* 1 : undefined		*/
  OBJECT_NAME ackec_name;		/* ack event cond name - for 	*/
					/* ackec_name_tag = 0 only	*/
  SD_END_STRUCT
  };
typedef struct event_enrollment	EVENT_ENROLLMENT;

struct alarm_summary
  {
  OBJECT_NAME evcon_name;		/* event condition name 	*/
  ST_UCHAR    severity;			/* severity			*/
  ST_INT16    cur_state;		/* current state		*/
					/*  0 : disabled		*/
					/*  1 : idle			*/
					/*  2 : active			*/
  ST_INT16    unack_state;		/* unacknowledged state 	*/
					/*  0 : none			*/
					/*  1 : active			*/
					/*  2 : idle			*/
					/*  3 : both			*/
  ST_BOOLEAN  addl_detail_pres;		/* additional detail present	*/
  ST_INT      addl_detail_len;		/* length of additional detail	*/
  ST_UCHAR    *addl_detail;		/* pointer to additional detail */
  ST_BOOLEAN  tta_time_pres;		/* transition to active time	*/
					/*   present			*/
  EVENT_TIME  tta_time;			/* transition to active time	*/
  ST_BOOLEAN  tti_time_pres;		/* transition to idle time	*/
					/*   present			*/
  EVENT_TIME  tti_time;			/* transition to idle time	*/
  SD_END_STRUCT
  };
typedef struct alarm_summary ALARM_SUMMARY;

struct alarm_enroll_summary
  {
  OBJECT_NAME evenroll_name;		/* event enrollment name 	*/
  ST_BOOLEAN  client_app_pres;		/* client application present	*/
  ST_INT      client_app_len;		/* client application length	*/
  ST_UCHAR    *client_app;		/* client application reference	*/
  ST_UCHAR    severity;			/* severity 			*/
  ST_INT16    cur_state;		/* current state		*/
					/*  0 : disabled		*/
					/*  1 : idle			*/
					/*  2 : active			*/
  ST_BOOLEAN  addl_detail_pres;		/* additional detail present	*/
  ST_INT      addl_detail_len;		/* length of additional detail	*/
  ST_UCHAR    *addl_detail;		/* pointer to additional detail */
  ST_BOOLEAN  not_lost;			/* notification lost		*/
					/*   (default = false)		*/
  ST_INT16    alarm_ack_rule;		/* alarm acknowledgment rule	*/
					/*  0 : none			*/
					/*  1 : simple			*/
					/*  2 : ack active		*/
					/*  3 : ack all			*/
  ST_BOOLEAN  ee_state_pres; 		/* enrollment state present	*/
  ST_INT16    ee_state;			/* enrollment state		*/
					/*  0 : disabled		*/
					/*  1 : idle			*/
					/*  2 : active			*/
					/*  3 : active, no ack a   	*/
					/*  4 : idle, no ack i 		*/
					/*  5 : idle, no ack a		*/
					/*  6 : idle, acked		*/
					/*  7 : active, acked 		*/
  ST_BOOLEAN  tta_time_pres;		/* transition to active time	*/
					/*   present			*/
  EVENT_TIME  tta_time;			/* transition to active time	*/
  ST_BOOLEAN  aack_time_pres;		/* active acknowledgment time	*/
					/*   present			*/
  EVENT_TIME  aack_time;		/* active acknowledgment time	*/
  ST_BOOLEAN  tti_time_pres;		/* transition to idle time	*/
					/*   present			*/
  EVENT_TIME  tti_time;			/* transition to idle time	*/
  ST_BOOLEAN  iack_time_pres;		/* idle acknowledgment time	*/
					/*   present			*/
  EVENT_TIME  iack_time;		/* idle acknowledgment time	*/
  SD_END_STRUCT
  };
typedef struct alarm_enroll_summary ALARM_ENROLL_SUMMARY;


/************************************************************************/
/************************************************************************/
/* DEFINE EVENT CONDITION						*/
/************************************************************************/

/* REQUEST :								*/

struct defec_req_info
  {
  OBJECT_NAME   evcon_name;		/* event condition name 	*/
  ST_INT16      eclass;  		/* event condition class:	*/
  ST_UCHAR      priority;		/* priority			*/
					/*   0 - highest		*/
					/*  64 - normal (default)	*/
					/* 127 - lowest 		*/
  ST_UCHAR      severity;		/* severity  (default = 64)	*/
  ST_BOOLEAN    as_reports_pres;	/* alarm summaray rpts present	*/
  ST_BOOLEAN    as_reports;		/* alarm summaray reports	*/
  ST_BOOLEAN    mon_var_pres;		/* monitored variable present	*/
  VARIABLE_SPEC var_ref;		/* variable reference		*/
  ST_BOOLEAN    eval_int_pres;		/* evaluation interval present	*/
  ST_UINT32     eval_interval;		/* evaluation interval		*/
  SD_END_STRUCT
  };
typedef struct defec_req_info DEFEC_REQ_INFO;

/* RESPONSE : NULL							*/

#ifndef MMS_LITE
MMSREQ_PEND *mp_defec (ST_INT chan, DEFEC_REQ_INFO *info);
ST_RET mp_defec_resp (MMSREQ_IND *ind);
#else
ST_RET mpl_defec (DEFEC_REQ_INFO *info);
ST_RET mpl_defec_resp (ST_UINT32 invoke);
#endif

/************************************************************************/
/* DELETE EVENT CONDITION 						*/
/************************************************************************/

/* REQUEST :								*/

struct delec_req_info
  {
  ST_INT16  req_tag;			/* request tag			*/
					/*   0 : specific		*/
					/*   1 : aa specific		*/
					/*   2 : domain			*/
					/*   3 : vmd			*/
  ST_CHAR   dname [MAX_IDENT_LEN+1]; 	/* domain name, if req_tag = 2	*/
  ST_INT    num_of_names;  		/* number of names, if tag = 0	*/
/*					   list of object names		*/
/*  OBJECT_NAME  name_list [num_of_names];			*/
  SD_END_STRUCT
  };
typedef struct delec_req_info DELEC_REQ_INFO;

/* RESPONSE :								*/

struct delec_resp_info
  {
  ST_UINT32   cand_not_deleted;		/* canditates not deleted	*/
  };
typedef struct delec_resp_info DELEC_RESP_INFO;
 
#ifndef MMS_LITE
MMSREQ_PEND *mp_delec (ST_INT chan, DELEC_REQ_INFO *info);
ST_RET mp_delec_resp (MMSREQ_IND *ind, DELEC_RESP_INFO *info);
#else
ST_RET mpl_delec (DELEC_REQ_INFO *info);
ST_RET mpl_delec_resp (ST_UINT32 invoke, DELEC_RESP_INFO *info);
#endif

/************************************************************************/
/* GET EVENT CONDITION ATTRIBUTES					*/
/************************************************************************/

/* REQUEST :								*/

struct geteca_req_info
  {
  OBJECT_NAME  evcon_name;		/* event condition name 	*/
  };
typedef struct geteca_req_info GETECA_REQ_INFO;

/* RESPONSE :								*/

struct geteca_resp_info
  {
  ST_BOOLEAN    mms_deletable;		/* mms deletable		*/
  ST_INT16      eclass;  		/* event condition class:	*/
  ST_UCHAR      priority;		/* priority			*/
					/*   0 - highest		*/
					/*  64 - normal (default)	*/
					/* 127 - lowest 		*/
  ST_UCHAR      severity;		/* severity			*/
					/*   0 - highest		*/
					/*  64 - normal (default)	*/
					/* 127 - lowest 		*/
  ST_BOOLEAN    as_reports;		/* alarm summaray reports	*/
  ST_BOOLEAN    mon_var_pres;		/* monitored variable present	*/
  ST_INT16      mon_var_tag;		/* monitored variable tag	*/
					/*   0 : variable reference	*/
					/*   1 : undefined (NULL)	*/
  VARIABLE_SPEC var_ref;		/* variable reference		*/
  ST_BOOLEAN    eval_int_pres;		/* evaluation interval present	*/
  ST_UINT32     eval_interval;		/* evaluation interval		*/
  SD_END_STRUCT
  };
typedef struct geteca_resp_info	GETECA_RESP_INFO;
 
#ifndef MMS_LITE
MMSREQ_PEND *mp_geteca (ST_INT chan, GETECA_REQ_INFO *info);
ST_RET mp_geteca_resp (MMSREQ_IND *ind, GETECA_RESP_INFO *info);
#else
ST_RET mpl_geteca (GETECA_REQ_INFO *info);
ST_RET mpl_geteca_resp (ST_UINT32 invoke, GETECA_RESP_INFO *info);
#endif

/************************************************************************/
/* REPORT EVENT CONDITION STATUS					*/
/************************************************************************/

/* REQUEST :								*/

struct repecs_req_info
  {
  OBJECT_NAME  evcon_name;		/* event condition name 	*/
  };
typedef struct repecs_req_info REPECS_REQ_INFO;

/* RESPONSE :								*/

struct repecs_resp_info
  {
  ST_INT16   cur_state;			/* event condition state:	*/
    					/*   0 - disabled		*/
    					/*   1 - idle			*/