A SBR descriptor. More...
#include <sbr.h>
Collaboration diagram for refda_amm_sbr_desc_t:Data Fields | |
| cace_ari_t | action |
| Action in the form of a Macro (MAC). | |
| cace_ari_t | condition |
| An SBR definition SHALL include a condition in the form of an Expression (EXPR). | |
| cace_ari_t | min_interval |
| An SBR definition SHALL include a minimum execution interval in the form of a non-negative 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. | |
Detailed Description
A SBR descriptor.
This defines the properties of a SBR in an Agent and includes common object metadata.
Field Documentation
◆ action
| cace_ari_t refda_amm_sbr_desc_t::action |
Action in the form of a Macro (MAC).
When triggered, the action execution SHALL be executed in accordance with Section 6.6 in an execution context with no parameters.
Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_sbr(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_amm_sbr_desc_deinit(), refda_amm_sbr_desc_init(), refda_exec_run_sbr(), refda_exec_sbr_enable(), test_refda_exec_state_based_rule(), and test_refda_exec_state_based_rule_cond_false_then_true().
◆ condition
| cace_ari_t refda_amm_sbr_desc_t::condition |
An SBR definition SHALL include a condition in the form of an Expression (EXPR).
The condition SHALL be evaluated in accordance with Section 6.7 in an evaluation context with no parameters. The result of the condition SHALL be converted to a BOOL value after evaluation and used to determine when to execute the action of the SBR.
Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_sbr(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_amm_sbr_desc_deinit(), refda_amm_sbr_desc_init(), refda_exec_check_sbr_condition(), refda_exec_sbr_enable(), test_refda_exec_state_based_rule(), and test_refda_exec_state_based_rule_cond_false_then_true().
◆ enabled
| bool refda_amm_sbr_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_sbr_list(), refda_amm_sbr_desc_init(), refda_exec_run_sbr(), refda_exec_sbr_disable(), and refda_exec_sbr_enable().
◆ exec_count
| cace_ari_uvast refda_amm_sbr_desc_t::exec_count |
Track state of current number of executions since the rule was enabled.
Referenced by refda_amm_sbr_desc_init(), refda_amm_sbr_desc_reached_max_exec_count(), refda_exec_run_sbr(), refda_exec_sbr_enable(), test_refda_exec_state_based_rule(), and test_refda_exec_state_based_rule_cond_false_then_true().
◆ init_enabled
| bool refda_amm_sbr_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_sbr(), refda_adm_ietf_dtnma_agent_ctrl_reset_rule_enabled(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_agent_init_sbr(), and refda_amm_sbr_desc_init().
◆ max_exec_count
| cace_ari_uvast refda_amm_sbr_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_sbr(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_amm_sbr_desc_init(), refda_amm_sbr_desc_reached_max_exec_count(), test_refda_exec_state_based_rule(), and test_refda_exec_state_based_rule_cond_false_then_true().
◆ min_interval
| cace_ari_t refda_amm_sbr_desc_t::min_interval |
An SBR definition SHALL include a minimum execution interval in the form of a non-negative TD value.
The interval MAY be zero to indicate that there is no minimum. This is not a limit on the interval of evaluations of the condition. This value can be used to limit potentially high processing loads on an Agent.
Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_sbr(), refda_adm_ietf_dtnma_agent_edd_sbr_list(), refda_amm_sbr_desc_deinit(), refda_amm_sbr_desc_init(), refda_exec_sbr_next_scheduled_time(), test_refda_exec_state_based_rule(), and test_refda_exec_state_based_rule_cond_false_then_true().
◆ obsolete
| bool refda_amm_sbr_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_sbr_list(), and refda_amm_sbr_desc_init().
The documentation for this struct was generated from the following file:
- src/refda/amm/sbr.h
