lookup.h File Reference

#include "obj_ns.h"
#include "obj_desc.h"
#include "obj_store.h"
#include "parameters.h"
#include "cace/ari.h"

Include dependency graph for lookup.h:

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

Data Structures
struct	cace_amm_lookup_t
	Result of dereferencing an object-reference ARI to an object descriptor within a specific namespace. More...

Macros
#define	M_OPL_cace_amm_lookup_t()

Functions
void	cace_amm_lookup_init (cace_amm_lookup_t *res)
	State initializer.
void	cace_amm_lookup_deinit (cace_amm_lookup_t *res)
	State de-initializer.
void	cace_amm_lookup_init_set (cace_amm_lookup_t *res, const cace_amm_lookup_t *src)
	Initializer with copy semantics.
void	cace_amm_lookup_init_move (cace_amm_lookup_t *res, cace_amm_lookup_t *src)
	Initializer with move semantics.
void	cace_amm_lookup_set (cace_amm_lookup_t *res, const cace_amm_lookup_t *src)
	Setter with copy semantics.
void	cace_amm_lookup_set_move (cace_amm_lookup_t *res, cace_amm_lookup_t *src)
	Setter with move semantics.
int	cace_amm_lookup_deref (cace_amm_lookup_t *res, const cace_amm_obj_store_t *store, const cace_ari_t *ref)
	Perform a lookup into an object store.
int	cace_amm_lookup_ref_int (cace_ari_t *ref, const cace_amm_lookup_t *src)
	Reverse a lookup to obtain an object reference value with integer identifiers.

Macro Definition Documentation

M_OPL_cace_amm_lookup_t

#define M_OPL_cace_amm_lookup_t

(

)

Value:

    (INIT(API_2(cace_amm_lookup_init)), INIT_SET(API_6(cace_amm_lookup_init_set)),      \
     INIT_MOVE(API_6(cace_amm_lookup_init_move)), CLEAR(API_2(cace_amm_lookup_deinit)), \
     SET(API_6(cace_amm_lookup_set)), MOVE(API_6(cace_amm_lookup_set_move)))

Function Documentation

cace_amm_lookup_deinit()

void cace_amm_lookup_deinit

(

cace_amm_lookup_t *

res

)

State de-initializer.

References cace_amm_lookup_t::aparams, cace_ari_itemized_deinit(), CACE_ARI_TYPE_NULL, CHKVOID, cace_amm_lookup_t::ns, cace_amm_lookup_t::obj, and cace_amm_lookup_t::obj_type.

Referenced by cace_amm_lookup_set(), cace_amm_lookup_set_move(), cace_amm_type_set_name_semtype(), check_lookup(), check_produce(), refda_adm_ietf_dtnma_agent_ctrl_ensure_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_inspect(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_const(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_rule(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_var(), refda_adm_ietf_dtnma_agent_ctrl_reset_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_var_reset(), refda_adm_ietf_dtnma_agent_ctrl_var_store(), refda_agent_get_object(), refda_amm_ident_base_deinit(), refda_binding_semtype_use(), refda_eval_expand(), refda_exec_item_deinit(), refda_exec_proc_exp_ref(), refda_reporting_item_ref(), refda_reporting_rptt_ref(), test_refda_adm_ietf_alarms_category_inventory(), test_refda_adm_ietf_alarms_list_no_category(), test_refda_adm_ietf_alarms_resource_inventory(), test_refda_adm_ietf_dtnma_agent_ctrl_var_store_reset(), and test_refda_adm_ietf_dtnma_agent_edd_produce().

cace_amm_lookup_deref()

int cace_amm_lookup_deref	(	cace_amm_lookup_t *	res,
		const cace_amm_obj_store_t *	store,
		const cace_ari_t *	ref
	)

Perform a lookup into an object store.

Parameters

[in,out]	res	The lookup result to reset and populate.
[in]	store	The object store to lookup within.
[in]	ref	The reference to lookup from.

Returns

Zero if successful. 1 if parameters are invalid (including an ARI that is not an object reference). 2 if the ARI type is invalid. 3 if the namespace ID does not resolve to a namespace. 4 if the object ID does not resolve to an object.

References cace_amm_lookup_t::aparams, cace_ari_objpath_t::ari_type, cace_ari_idseg_t::as_int, cace_ari_t::as_ref, cace_ari_idseg_t::as_text, cace_amm_actual_param_set_populate(), cace_amm_obj_ns_find_obj_enum(), cace_amm_obj_ns_find_obj_name(), cace_amm_obj_org_find_ns_enum(), cace_amm_obj_org_find_ns_name(), cace_amm_obj_store_find_org_enum(), cace_amm_obj_store_find_org_name(), cace_ari_itemized_reset(), CACE_ARI_TYPE_NULL, CHKERR1, cace_ari_idseg_t::form, cace_amm_obj_desc_t::fparams, cace_ari_objpath_t::has_ari_type, cace_ari_t::is_ref, cace_ari_objpath_t::model_id, cace_amm_lookup_t::ns, cace_amm_lookup_t::obj, cace_ari_objpath_t::obj_id, cace_amm_lookup_t::obj_type, cace_ari_ref_t::objpath, cace_ari_objpath_t::org_id, cace_ari_ref_t::params, and store.

Referenced by cace_amm_type_set_name_semtype(), check_execute(), check_lookup(), check_produce(), refda_adm_ietf_dtnma_agent_ctrl_ensure_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_inspect(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_const(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_rule(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_var(), refda_adm_ietf_dtnma_agent_ctrl_reset_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_var_reset(), refda_adm_ietf_dtnma_agent_ctrl_var_store(), refda_agent_get_object(), refda_amm_ident_base_populate(), refda_binding_semtype_use(), refda_endpoint_pat_match(), refda_eval_expand(), refda_exec_proc_exp_ref(), refda_reporting_item_ref(), refda_reporting_rptt_ref(), test_refda_adm_ietf_alarms_category_inventory(), test_refda_adm_ietf_alarms_list_no_category(), test_refda_adm_ietf_alarms_resource_inventory(), test_refda_adm_ietf_dtnma_agent_ctrl_var_store_reset(), and test_refda_adm_ietf_dtnma_agent_edd_produce().

cace_amm_lookup_init()

void cace_amm_lookup_init

(

cace_amm_lookup_t *

res

)

State initializer.

References cace_amm_lookup_t::aparams, cace_ari_itemized_init(), CHKVOID, cace_amm_lookup_t::ns, and cace_amm_lookup_t::obj.

Referenced by cace_amm_type_set_name_semtype(), check_execute(), check_lookup(), check_produce(), refda_adm_ietf_dtnma_agent_ctrl_ensure_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_inspect(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_const(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_rule(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_var(), refda_adm_ietf_dtnma_agent_ctrl_reset_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_var_reset(), refda_adm_ietf_dtnma_agent_ctrl_var_store(), refda_agent_get_object(), refda_amm_ident_base_init(), refda_binding_semtype_use(), refda_eval_expand(), refda_exec_item_init(), refda_exec_proc_exp_ref(), refda_reporting_item_ref(), refda_reporting_rptt_ref(), test_refda_adm_ietf_alarms_category_inventory(), test_refda_adm_ietf_alarms_list_no_category(), test_refda_adm_ietf_alarms_resource_inventory(), test_refda_adm_ietf_dtnma_agent_ctrl_var_store_reset(), and test_refda_adm_ietf_dtnma_agent_edd_produce().

cace_amm_lookup_init_move()

void cace_amm_lookup_init_move	(	cace_amm_lookup_t *	res,
		cace_amm_lookup_t *	src
	)

Initializer with move semantics.

References cace_amm_lookup_t::aparams, cace_ari_itemized_init_move(), CACE_ARI_TYPE_NULL, CHKVOID, cace_amm_lookup_t::ns, cace_amm_lookup_t::obj, and cace_amm_lookup_t::obj_type.

Referenced by cace_amm_lookup_set_move().

cace_amm_lookup_init_set()

void cace_amm_lookup_init_set	(	cace_amm_lookup_t *	res,
		const cace_amm_lookup_t *	src
	)

Initializer with copy semantics.

References cace_amm_lookup_t::aparams, cace_ari_itemized_init_set(), CHKVOID, cace_amm_lookup_t::ns, cace_amm_lookup_t::obj, and cace_amm_lookup_t::obj_type.

Referenced by cace_amm_lookup_set().

cace_amm_lookup_ref_int()

int cace_amm_lookup_ref_int	(	cace_ari_t *	ref,
		const cace_amm_lookup_t *	src
	)

Reverse a lookup to obtain an object reference value with integer identifiers.

Parameters

[in]	src	The lookup to convert back to a reference.
[in,out]	ref	The value to populate with a reference.

Returns

Zero if successful.

References cace_ari_set_objref_path_intid(), CHKERR1, CHKRET, cace_amm_idseg_val_t::has_intenum, cace_amm_idseg_val_t::intenum, cace_amm_obj_ns_t::model_id, cace_amm_lookup_t::ns, cace_amm_lookup_t::obj, cace_amm_obj_desc_t::obj_id, cace_amm_lookup_t::obj_type, and cace_amm_obj_ns_t::org_id.

Referenced by alarms_append_derived_ident().

cace_amm_lookup_set()

void cace_amm_lookup_set	(	cace_amm_lookup_t *	res,
		const cace_amm_lookup_t *	src
	)

Setter with copy semantics.

References cace_amm_lookup_deinit(), and cace_amm_lookup_init_set().

Referenced by refda_amm_ident_base_set().

cace_amm_lookup_set_move()

void cace_amm_lookup_set_move	(	cace_amm_lookup_t *	res,
		cace_amm_lookup_t *	src
	)

Setter with move semantics.

References cace_amm_lookup_deinit(), and cace_amm_lookup_init_move().

Referenced by check_execute(), refda_amm_ident_base_set_move(), and refda_exec_proc_exp_ref().