ietf_alarms.h File Reference

This is the header for the implementation of the ADM module "ietf-alarms" for the C-language reference DA. More...

#include "refda/agent.h"
#include <cace/util/defs.h>

Include dependency graph for ietf_alarms.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	REFDA_ADM_IETF_ALARMS_ENUM_ADM   4
	Enumeration of the ADM itself.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_RESOURCE   0
	For ./IDENT/resource.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_CATEGORY   1
	For ./IDENT/category.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SEVERITY   0
	For ./TYPEDEF/severity.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_MANAGER_STATE   1
	For ./TYPEDEF/manager-state.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_ALARM_FILTER   2
	For ./TYPEDEF/alarm-filter.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SHELF_TBLT   3
	For ./TYPEDEF/shelf-tblt.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_ALARM_LIST   0
	For ./EDD/alarm-list.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_RESOURCE_INVENTORY   1
	For ./EDD/resource-inventory.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_CATEGORY_INVENTORY   2
	For ./EDD/category-inventory.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_SHELF_LIST   3
	For ./EDD/shelf-list.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_PURGE_ALARMS   2
	For ./CTRL/purge-alarms.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_COMPRESS_ALARMS   3
	For ./CTRL/compress-alarms.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_SET_ALARMS_MANAGER_STATE   4
	For ./CTRL/set-alarms-manager-state.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_ENSURE_SHELF   0
	For ./CTRL/ensure-shelf.
#define	REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_DISCARD_SHELF   1
	For ./CTRL/discard-shelf.

Functions
int	refda_adm_ietf_alarms_init (refda_agent_t *agent)
	Initializer for the ADM module ietf-alarms.

Detailed Description

This is the header for the implementation of the ADM module "ietf-alarms" for the C-language reference DA.

This contains defines for each enumeration in the ADM and declarations of module-level initialization functions.

Macro Definition Documentation

REFDA_ADM_IETF_ALARMS_ENUM_ADM

#define REFDA_ADM_IETF_ALARMS_ENUM_ADM   4

Enumeration of the ADM itself.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_COMPRESS_ALARMS

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_COMPRESS_ALARMS   3

For ./CTRL/compress-alarms.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_DISCARD_SHELF

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_DISCARD_SHELF   1

For ./CTRL/discard-shelf.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_ENSURE_SHELF

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_ENSURE_SHELF   0

For ./CTRL/ensure-shelf.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_PURGE_ALARMS

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_PURGE_ALARMS   2

For ./CTRL/purge-alarms.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_SET_ALARMS_MANAGER_STATE

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_SET_ALARMS_MANAGER_STATE   4

For ./CTRL/set-alarms-manager-state.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_ALARM_LIST

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_ALARM_LIST   0

For ./EDD/alarm-list.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_CATEGORY_INVENTORY

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_CATEGORY_INVENTORY   2

For ./EDD/category-inventory.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_RESOURCE_INVENTORY

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_RESOURCE_INVENTORY   1

For ./EDD/resource-inventory.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_SHELF_LIST

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_SHELF_LIST   3

For ./EDD/shelf-list.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_CATEGORY

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_CATEGORY   1

For ./IDENT/category.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_RESOURCE

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_RESOURCE   0

For ./IDENT/resource.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_ALARM_FILTER

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_ALARM_FILTER   2

For ./TYPEDEF/alarm-filter.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_MANAGER_STATE

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_MANAGER_STATE   1

For ./TYPEDEF/manager-state.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SEVERITY

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SEVERITY   0

For ./TYPEDEF/severity.

REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SHELF_TBLT

#define REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SHELF_TBLT   3

For ./TYPEDEF/shelf-tblt.

Function Documentation

refda_adm_ietf_alarms_init()

int refda_adm_ietf_alarms_init

(

refda_agent_t *

agent

)

Initializer for the ADM module ietf-alarms.

Parameters

[in,out]

agent

The agent to register this namespace and its objects within.

Returns

Zero upon success.

Register IDENT objects

Register TYPEDEF objects

Register EDD objects

Register CTRL objects

References refda_amm_ident_desc_t::abstract, agent, cace_amm_idseg_ref_withenum(), cace_amm_obj_store_add_ns(), cace_amm_type_set_tblt_size(), cace_amm_type_set_union_size(), cace_amm_type_set_use_ref_move(), CACE_ARI_INIT_UNDEFINED, cace_ari_set_aritype(), cace_ari_set_objref_path_intid(), CACE_ARI_TYPE_IDENT, CACE_ARI_TYPE_NULL, CACE_ARI_TYPE_TYPEDEF, CACE_ARI_TYPE_UINT, CACE_ARI_TYPE_UVAST, CACE_LOG_DEBUG, CACE_MALLOC, CHKERR1, cace_amm_semtype_union_t::choices, cace_amm_semtype_tblt_t::columns, refda_amm_ctrl_desc_t::execute, cace_amm_named_type_t::name, refda_agent_t::objs, refda_amm_edd_desc_t::prod_type, refda_amm_edd_desc_t::produce, refda_adm_ietf_alarms_ctrl_compress_alarms(), refda_adm_ietf_alarms_ctrl_discard_shelf(), refda_adm_ietf_alarms_ctrl_ensure_shelf(), refda_adm_ietf_alarms_ctrl_purge_alarms(), refda_adm_ietf_alarms_ctrl_set_alarms_manager_state(), refda_adm_ietf_alarms_edd_alarm_list(), refda_adm_ietf_alarms_edd_category_inventory(), refda_adm_ietf_alarms_edd_resource_inventory(), refda_adm_ietf_alarms_edd_shelf_list(), REFDA_ADM_IETF_ALARMS_ENUM_ADM, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_COMPRESS_ALARMS, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_DISCARD_SHELF, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_ENSURE_SHELF, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_PURGE_ALARMS, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_CTRL_SET_ALARMS_MANAGER_STATE, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_ALARM_LIST, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_CATEGORY_INVENTORY, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_RESOURCE_INVENTORY, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_EDD_SHELF_LIST, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_CATEGORY, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_IDENT_RESOURCE, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_ALARM_FILTER, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_MANAGER_STATE, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SEVERITY, REFDA_ADM_IETF_ALARMS_ENUM_OBJID_TYPEDEF_SHELF_TBLT, REFDA_AGENT_ERR_LOCK_FAILED, REFDA_AGENT_LOCK, REFDA_AGENT_UNLOCK, refda_amm_ctrl_desc_init(), refda_amm_edd_desc_init(), refda_amm_ident_desc_init(), refda_amm_typedef_desc_init(), refda_register_add_param(), refda_register_ctrl(), refda_register_edd(), refda_register_ident(), refda_register_typedef(), refda_amm_ctrl_desc_t::res_type, cace_amm_named_type_t::typeobj, cace_amm_formal_param_t::typeobj, and refda_amm_typedef_desc_t::typeobj.

Referenced by refda_loader_basemods(), and test_util_agent_crit_adms().