register.h File Reference

#include "amm/ident.h"
#include "amm/typedef.h"
#include "amm/const.h"
#include "amm/var.h"
#include "amm/edd.h"
#include "amm/ctrl.h"
#include "amm/oper.h"
#include "amm/sbr.h"
#include "amm/tbr.h"
#include "cace/amm/idseg_ref.h"
#include "cace/amm/obj_ns.h"

Include dependency graph for register.h:

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

Functions
cace_amm_obj_desc_t *	refda_register_ident (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_ident_desc_t *desc)
	Register an IDENT object with optional user data.
cace_amm_obj_desc_t *	refda_register_typedef (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_typedef_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_const (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_const_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_var (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_var_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_edd (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_edd_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_ctrl (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_ctrl_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_oper (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_oper_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_sbr (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_sbr_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_obj_desc_t *	refda_register_tbr (cace_amm_obj_ns_t *ns, const cace_amm_idseg_ref_t obj_id, refda_amm_tbr_desc_t *desc)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
cace_amm_formal_param_t *	refda_register_add_param (cace_amm_obj_desc_t *obj, const char *name)
	Helper function to append a named parameter to an object descriptor.

Function Documentation

refda_register_add_param()

cace_amm_formal_param_t * refda_register_add_param	(	cace_amm_obj_desc_t *	obj,
		const char *	name
	)

Helper function to append a named parameter to an object descriptor.

Parameters

[in,out]	obj	The object to add a parameter onto.
[in]	name	The name of the new parameter.

Returns

The new parameter definition.

References CHKNULL, cace_amm_obj_desc_t::fparams, cace_amm_formal_param_t::index, and cace_amm_formal_param_t::name.

Referenced by refda_adm_ietf_alarms_init(), refda_adm_ietf_amm_semtype_init(), refda_adm_ietf_bp_base_init(), refda_adm_ietf_dtnma_agent_acl_init(), refda_adm_ietf_dtnma_agent_init(), refda_adm_ietf_inet_base_init(), refda_adm_ietf_network_base_init(), suite_adms_init(), suite_adms_init(), and suite_adms_init().

refda_register_const()

cace_amm_obj_desc_t * refda_register_const	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_const_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_CONST, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_const_desc_deinit(), and refda_amm_const_desc_init().

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_const(), refda_adm_ietf_dtnma_agent_init(), suite_adms_init(), suite_adms_init(), suite_adms_init(), and suite_adms_init().

refda_register_ctrl()

cace_amm_obj_desc_t * refda_register_ctrl	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_ctrl_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_CTRL, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_ctrl_desc_deinit(), and refda_amm_ctrl_desc_init().

Referenced by refda_adm_ietf_alarms_init(), refda_adm_ietf_dtnma_agent_acl_init(), refda_adm_ietf_dtnma_agent_init(), suite_adms_init(), and suite_adms_init().

refda_register_edd()

cace_amm_obj_desc_t * refda_register_edd	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_edd_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_EDD, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_edd_desc_deinit(), and refda_amm_edd_desc_init().

Referenced by refda_adm_ietf_alarms_init(), refda_adm_ietf_dtnma_agent_acl_init(), refda_adm_ietf_dtnma_agent_init(), suite_adms_init(), suite_adms_init(), and suite_adms_init().

refda_register_ident()

cace_amm_obj_desc_t * refda_register_ident	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_ident_desc_t *	desc
	)

Register an IDENT object with optional user data.

Parameters

[in]	ns	The namespace (ADM or ODM) to register into. The pointer must be non-null.
	obj_id	The identifiers for the registered object. The values are copied so these are pure references.
[in,out]	desc	The IDENT descriptor to move from. If this pointer is null, a default IDENT descriptor is allocated.

Returns

A non-null pointer to the created object descriptor if successful or NULL if failed.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_IDENT, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_ident_desc_deinit(), and refda_amm_ident_desc_init().

Referenced by refda_adm_iana_display_hints_init(), refda_adm_ietf_alarms_init(), refda_adm_ietf_amm_base_init(), refda_adm_ietf_amm_semtype_init(), refda_adm_ietf_bp_base_init(), refda_adm_ietf_dtnma_agent_acl_init(), refda_adm_ietf_inet_base_init(), refda_adm_ietf_network_base_init(), and suiteSetUp().

refda_register_oper()

cace_amm_obj_desc_t * refda_register_oper	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_oper_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_OPER, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_oper_desc_deinit(), and refda_amm_oper_desc_init().

Referenced by refda_adm_ietf_dtnma_agent_init(), and suite_adms_init().

refda_register_sbr()

cace_amm_obj_desc_t * refda_register_sbr	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_sbr_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_SBR, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_sbr_desc_deinit(), and refda_amm_sbr_desc_init().

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_sbr().

refda_register_tbr()

cace_amm_obj_desc_t * refda_register_tbr	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_tbr_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_TBR, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_tbr_desc_deinit(), and refda_amm_tbr_desc_init().

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr().

refda_register_typedef()

cace_amm_obj_desc_t * refda_register_typedef	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_typedef_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_TYPEDEF, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_typedef_desc_deinit(), and refda_amm_typedef_desc_init().

Referenced by refda_adm_ietf_alarms_init(), refda_adm_ietf_amm_base_init(), refda_adm_ietf_amm_semtype_init(), refda_adm_ietf_bp_base_init(), refda_adm_ietf_dtnma_agent_acl_init(), refda_adm_ietf_dtnma_agent_init(), refda_adm_ietf_inet_base_init(), and refda_adm_ietf_network_base_init().

refda_register_var()

cace_amm_obj_desc_t * refda_register_var	(	cace_amm_obj_ns_t *	ns,
		const cace_amm_idseg_ref_t	obj_id,
		refda_amm_var_desc_t *	desc
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

References cace_amm_obj_desc_t::app_data, cace_amm_obj_ns_add_obj(), cace_amm_user_data_set_from(), CACE_ARI_TYPE_VAR, CACE_FREE, CACE_MALLOC, CHKNULL, refda_amm_var_desc_deinit(), and refda_amm_var_desc_init().

Referenced by refda_adm_ietf_dtnma_agent_acl_init(), refda_adm_ietf_dtnma_agent_ctrl_ensure_var(), suite_adms_init(), suite_adms_init(), and suiteSetUp().