runctx.h File Reference

#include "acl.h"
#include "cace/ari/base.h"
#include "cace/amm/lookup.h"
#include <m-shared-ptr.h>

Include dependency graph for runctx.h:

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

Data Structures
struct	refda_amm_modval_state_t
	Modifiable value state counter. More...
struct	refda_runctx_t
	Context for all agent runtime activities. More...

Macros
#define	M_OPL_refda_runctx_t()   (INIT(API_2(refda_runctx_init)), INIT_SET(0), CLEAR(API_2(refda_runctx_deinit)), SET(0))
	M*LIB OPLIST for refda_runctx_t.

Typedefs
typedef struct refda_agent_s	refda_agent_t
typedef struct refda_msgdata_s	refda_msgdata_t

Functions
void	refda_amm_modval_state_init (refda_amm_modval_state_t *obj)
void	refda_amm_modval_state_deinit (refda_amm_modval_state_t *obj)
void	refda_amm_modval_state_inc (refda_amm_modval_state_t *obj)
	Increment the counter to the next value and signal to a registered callback.
void	refda_runctx_init (refda_runctx_t *ctx)
void	refda_runctx_deinit (refda_runctx_t *ctx)
void	refda_runctx_from (refda_runctx_t *ctx, refda_agent_t *agent, const refda_msgdata_t *msg)
	Take values for a runtime context.
void	refda_runctx_check_acl (refda_runctx_t *ctx)
	Verify the ACL cache is valid.

Macro Definition Documentation

M_OPL_refda_runctx_t

#define M_OPL_refda_runctx_t

(

)

(INIT(API_2(refda_runctx_init)), INIT_SET(0), CLEAR(API_2(refda_runctx_deinit)), SET(0))

M*LIB OPLIST for refda_runctx_t.

Typedef Documentation

refda_agent_t

typedef struct refda_agent_s refda_agent_t

refda_msgdata_t

typedef struct refda_msgdata_s refda_msgdata_t

Function Documentation

refda_amm_modval_state_deinit()

void refda_amm_modval_state_deinit

(

refda_amm_modval_state_t *

obj

)

refda_amm_modval_state_inc()

void refda_amm_modval_state_inc

(

refda_amm_modval_state_t *

obj

)

Increment the counter to the next value and signal to a registered callback.

References refda_amm_modval_state_t::_ctr, refda_amm_modval_state_t::notify, and refda_amm_modval_state_t::notify_user_data.

refda_amm_modval_state_init()

void refda_amm_modval_state_init

(

refda_amm_modval_state_t *

obj

)

References refda_amm_modval_state_t::_ctr, refda_amm_modval_state_t::notify, and refda_amm_modval_state_t::notify_user_data.

refda_runctx_check_acl()

void refda_runctx_check_acl

(

refda_runctx_t *

ctx

)

Verify the ACL cache is valid.

References refda_agent_t::acl, refda_runctx_t::acl_gen, refda_runctx_t::acl_groups, refda_runctx_t::agent, cace_ari_is_undefined(), refda_acl_t::generation, refda_runctx_t::mgr_ident, and refda_acl_search_endpoint().

Referenced by refda_ctrl_exec_ctx_init(), refda_reporting_ctx_init(), and refda_runctx_from().

refda_runctx_deinit()

void refda_runctx_deinit

(

refda_runctx_t *

ctx

)

References refda_runctx_t::acl_groups, refda_runctx_t::agent, cace_ari_deinit(), CHKVOID, refda_runctx_t::mgr_ident, and refda_runctx_t::nonce.

Referenced by check_produce(), refda_exec_check_sbr_condition(), refda_reporting_ctx_deinit(), TEST_CASE(), 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(), test_refda_adm_ietf_dtnma_agent_edd_produce(), test_refda_alarms_compress_all(), test_refda_alarms_mgr_state_warning(), test_refda_alarms_purge_all(), test_refda_alarms_purge_warning(), test_refda_eval_target_failure(), and test_refda_reporting_target().

refda_runctx_from()

void refda_runctx_from	(	refda_runctx_t *	ctx,
		refda_agent_t *	agent,
		const refda_msgdata_t *	msg
	)

Take values for a runtime context.

Parameters

[out]	ctx	The context to initialize.
[in]	agent	The agent being run within.
[in]	msg	The optional EXECSET message being run within. When this is provided, the refda_runctx_t::nonce and refda_runctx_t::acl_groups fields are populated. When absent, the nonce is always null and group zero (the Agent) is assumed.

References agent, refda_runctx_t::agent, cace_ari_cget_execset(), cace_ari_reset(), cace_ari_set_copy(), CHKVOID, refda_msgdata_t::ident, refda_runctx_t::mgr_ident, cace_ari_execset_t::nonce, refda_runctx_t::nonce, refda_runctx_check_acl(), and refda_msgdata_t::value.

Referenced by check_execute(), check_execute(), refda_agent_startup_exec(), refda_exec_add_execset(), refda_exec_check_sbr_condition(), refda_exec_rule_action(), test_util_agent_check_execute(), and test_util_runctx_init().

refda_runctx_init()

void refda_runctx_init

(

refda_runctx_t *

ctx

)

References refda_runctx_t::acl_gen, refda_runctx_t::acl_groups, refda_runctx_t::agent, cace_ari_init(), CHKVOID, refda_runctx_t::mgr_ident, and refda_runctx_t::nonce.

Referenced by refda_exec_check_sbr_condition(), refda_reporting_ctx_init(), and test_util_runctx_init().