A TBR descriptor. More...

#include <tbr.h>

Collaboration diagram for refda_amm_tbr_desc_t:

Data Fields
cace_ari_t	action
	Action in the form of a Macro (MAC), which must be a valid execution target.

cace_ari_t	start_time
	Start time in the form of a TIME (TP or TD) value.

cace_ari_t	period
	Time period in the form of a positive TD value.

cace_ari_uvast	max_exec_count
	Maximum execution count in the form of a non-negative UVAST value.

bool	init_enabled
	Initial value for rule's enabled state.

bool	enabled
	Current enabled state of the rule.

bool	obsolete
	Determine whether the rule has been marked obsolete.

cace_ari_uvast	exec_count
	Track state of current number of executions since the rule was enabled.

struct timespec	absolute_start_time
	State field to track the absolute time used as reference for a relative start time.

Detailed Description

A TBR descriptor.

This defines the properties of a TBR in an Agent and includes common object metadata.

Field Documentation

◆ absolute_start_time

struct timespec refda_amm_tbr_desc_t::absolute_start_time

State field to track the absolute time used as reference for a relative start time.

For ADM rules this is when the Agent is initialized For ODM rules this is when the rule was created

Referenced by refda_amm_tbr_desc_init(), refda_exec_tbr_next_scheduled_time(), and test_refda_exec_time_based_rule().

◆ action

cace_ari_t refda_amm_tbr_desc_t::action

Action in the form of a Macro (MAC), which must be a valid execution target.

When triggered, the action SHALL be executed in an execution context with no parameters.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_amm_tbr_desc_deinit(), refda_amm_tbr_desc_init(), refda_exec_run_tbr(), refda_exec_tbr_enable(), and test_refda_exec_time_based_rule().

◆ enabled

bool refda_amm_tbr_desc_t::enabled

Current enabled state of the rule.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_rule_enabled(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_rule(), refda_adm_ietf_dtnma_agent_ctrl_reset_rule_enabled(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_amm_tbr_desc_init(), refda_exec_run_tbr(), refda_exec_tbr_disable(), and refda_exec_tbr_enable().

◆ exec_count

cace_ari_uvast refda_amm_tbr_desc_t::exec_count

Track state of current number of executions since the rule was enabled.

Referenced by refda_amm_tbr_desc_init(), refda_amm_tbr_desc_reached_max_exec_count(), refda_exec_run_tbr(), refda_exec_tbr_enable(), and test_refda_exec_time_based_rule().

◆ init_enabled

bool refda_amm_tbr_desc_t::init_enabled

Initial value for rule's enabled state.

If not provided, the initial enabled state SHALL be true.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_ctrl_reset_rule_enabled(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_agent_init_tbr(), and refda_amm_tbr_desc_init().

◆ max_exec_count

cace_ari_uvast refda_amm_tbr_desc_t::max_exec_count

Maximum execution count in the form of a non-negative UVAST value.

The count sentinel value zero SHALL be interpreted as having no maximum. This is not a limit on the number of evaluations of the condition.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_amm_tbr_desc_init(), refda_amm_tbr_desc_reached_max_exec_count(), and test_refda_exec_time_based_rule().

◆ obsolete

bool refda_amm_tbr_desc_t::obsolete

Determine whether the rule has been marked obsolete.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_obsolete_rule(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), and refda_amm_tbr_desc_init().

◆ period

cace_ari_t refda_amm_tbr_desc_t::period

Time period in the form of a positive TD value.

The period SHALL NOT be zero but any non-zero small period is valid.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_edd_tbr_list(), refda_amm_tbr_desc_deinit(), refda_amm_tbr_desc_init(), refda_exec_tbr_next_scheduled_time(), and test_refda_exec_time_based_rule().

◆ start_time

cace_ari_t refda_amm_tbr_desc_t::start_time

Start time in the form of a TIME (TP or TD) value.

A relative start time SHALL be interpreted relative to the absolute time at which the Agent is initialized (for ADM rules) or the rule is created (for ODM rules). The start time MAY be the relative time zero to indicate that the TBR is always active. This is not a limit on the interval of evaluations of the condition.