MADARA
3.4.1
|
Encapsulates settings for an evaluation statement. More...
#include <EvalSettings.h>
Public Member Functions | |
EvalSettings () | |
Constructor. More... | |
EvalSettings (bool t_delay_sending_modifieds, bool t_treat_globals_as_locals=false, bool t_signal_updates=true, bool t_always_overwrite=false, bool t_always_expand=true, bool t_track_local_changes=false, std::string t_pre_print_statement="", std::string t_post_print_statement="", uint64_t t_clock_increment=1, bool t_treat_locals_as_globals=false, bool t_stream_changes=true, bool t_exceptions_on_unitialized=false) | |
Constructor. More... | |
EvalSettings (const EvalSettings &rhs) | |
Copy constructor. More... | |
Public Attributes | |
bool | always_overwrite = false |
Toggle for always overwriting records, regardless of quality, clock values, etc. More... | |
uint64_t | clock_increment = 1 |
Default clock increment. More... | |
bool | delay_sending_modifieds |
Toggle for sending modifieds in a single update event after each evaluation. More... | |
bool | exception_on_unitialized |
throw an exception if reference is on uninitialized variable More... | |
bool | expand_variables |
Toggle for always attempting to expand variables (true) or never expanding variables (false) More... | |
bool | never_exit |
Never allow MADARA to exit, even with fatal errors or invalid state. More... | |
std::string | post_print_statement |
Statement to print after evaluations. More... | |
std::string | pre_print_statement |
Statement to print before evaluations. More... | |
std::map< std::string, bool > | send_list |
Map of record names that are allowed to be sent after operation. More... | |
bool | signal_changes = true |
Toggle whether to signal changes have happened. More... | |
bool | stream_changes = true |
Toggle for streaming support. More... | |
bool | track_local_changes = true |
Toggle for checkpointing support. More... | |
bool | treat_globals_as_locals = false |
Toggle whether updates to global variables are treated as local variables and not marked as modified to the transport. More... | |
bool | treat_locals_as_globals = false |
Toggle whether updates to local variables are treated as global variables that should be sent over the transport. More... | |
Static Public Attributes | |
static const EvalSettings | CHECKPOINT |
Settings to enable checkpoints. More... | |
static const EvalSettings | DEFAULT |
Settings to use whatever defaults there are. More... | |
static const EvalSettings | DELAY |
Settings to delay sending modifieds and expand variables. More... | |
static const EvalSettings | DELAY_CHECKPOINT |
Settings to delay sending modifieds and enable checkpoints. More... | |
static const EvalSettings | DELAY_EXPAND |
Settings to delay sending modifieds and expand variables. More... | |
static const EvalSettings | DELAY_NO_EXPAND |
Settings to delay send modifieds and not expand variables. More... | |
static const EvalSettings | EXPAND |
Settings to delay sending modifieds and expand variables. More... | |
static const KnowledgeUpdateSettings | GLOBAL_AS_LOCAL |
static const KnowledgeUpdateSettings | GLOBAL_AS_LOCAL_NO_EXPAND |
static const EvalSettings | NO_EXPAND |
Settings to delay sending modifieds and expand variables. More... | |
static const EvalSettings | NO_EXPAND_CHECKPOINT |
Settings to not expand odifieds and enable checkpoints. More... | |
static const EvalSettings | SEND |
Settings to immediately send modifieds and expand variables. More... | |
static const EvalSettings | SEND_EXPAND |
Settings to immediately send modifieds and expand variables. More... | |
static const EvalSettings | SEND_NO_EXPAND |
Settings to immediately send modifieds and not expand variables. More... | |
Encapsulates settings for an evaluation statement.
Definition at line 25 of file EvalSettings.h.
|
inline |
Constructor.
Definition at line 68 of file EvalSettings.h.
|
inlineexplicit |
Constructor.
t_delay_sending_modifieds | true to send modifieds |
t_treat_globals_as_locals | true if global variables should be marked as not to be sent to the transport |
t_signal_updates | indicates whether to signal updates to a separate thread that may be waiting. This is only potentially useful to multithreaded MADARA apps |
t_always_overwrite | always overwrite, despite quality |
t_always_expand | always try to expand variable names |
t_track_local_changes | if true, keep track of modifications to local variables for checkpoint saving purposes. |
t_pre_print_statement | statement to print out before evaluations |
t_post_print_statement | statement to print out after evaluations |
t_clock_increment | amount of clock ticks to increment updated records by |
t_treat_locals_as_globals | true if local variable changes should be sent over the network (dangerous). |
t_stream_changes | true if changes must be streamed |
t_exceptions_on_unitialized | true if exceptions must be thrown when reading uninitialized variables |
Definition at line 104 of file EvalSettings.h.
|
inline |
Copy constructor.
rhs | Eval settings instance to copy |
Definition at line 128 of file EvalSettings.h.
|
inherited |
Toggle for always overwriting records, regardless of quality, clock values, etc.
Definition at line 114 of file KnowledgeUpdateSettings.h.
|
static |
Settings to enable checkpoints.
Definition at line 33 of file EvalSettings.h.
|
inherited |
Default clock increment.
Definition at line 126 of file KnowledgeUpdateSettings.h.
|
static |
Settings to use whatever defaults there are.
Definition at line 30 of file EvalSettings.h.
|
static |
Settings to delay sending modifieds and expand variables.
Definition at line 36 of file EvalSettings.h.
|
static |
Settings to delay sending modifieds and enable checkpoints.
Definition at line 39 of file EvalSettings.h.
|
static |
Settings to delay sending modifieds and expand variables.
Definition at line 45 of file EvalSettings.h.
|
static |
Settings to delay send modifieds and not expand variables.
Definition at line 48 of file EvalSettings.h.
bool madara::knowledge::EvalSettings::delay_sending_modifieds |
Toggle for sending modifieds in a single update event after each evaluation.
Definition at line 141 of file EvalSettings.h.
|
inherited |
throw an exception if reference is on uninitialized variable
Definition at line 76 of file KnowledgeReferenceSettings.h.
|
static |
Settings to delay sending modifieds and expand variables.
Definition at line 42 of file EvalSettings.h.
|
inherited |
Toggle for always attempting to expand variables (true) or never expanding variables (false)
Definition at line 68 of file KnowledgeReferenceSettings.h.
|
staticinherited |
Definition at line 29 of file KnowledgeUpdateSettings.h.
|
staticinherited |
Definition at line 30 of file KnowledgeUpdateSettings.h.
|
inherited |
Never allow MADARA to exit, even with fatal errors or invalid state.
Definition at line 73 of file KnowledgeReferenceSettings.h.
|
static |
Settings to delay sending modifieds and expand variables.
Definition at line 51 of file EvalSettings.h.
|
static |
Settings to not expand odifieds and enable checkpoints.
Definition at line 54 of file EvalSettings.h.
std::string madara::knowledge::EvalSettings::post_print_statement |
Statement to print after evaluations.
Definition at line 151 of file EvalSettings.h.
std::string madara::knowledge::EvalSettings::pre_print_statement |
Statement to print before evaluations.
Definition at line 146 of file EvalSettings.h.
|
static |
Settings to immediately send modifieds and expand variables.
Definition at line 57 of file EvalSettings.h.
|
static |
Settings to immediately send modifieds and expand variables.
Definition at line 60 of file EvalSettings.h.
std::map<std::string, bool> madara::knowledge::EvalSettings::send_list |
Map of record names that are allowed to be sent after operation.
The map is only valid if
Definition at line 157 of file EvalSettings.h.
|
static |
Settings to immediately send modifieds and not expand variables.
Definition at line 63 of file EvalSettings.h.
|
inherited |
Toggle whether to signal changes have happened.
Setting this to false will increase performance, but in general should be left to true. Setting this to false can result in problems with wait statements.
Definition at line 108 of file KnowledgeUpdateSettings.h.
|
inherited |
Toggle for streaming support.
If this is true, all changes will be streamed to the attached streamer, if any.
Definition at line 144 of file KnowledgeUpdateSettings.h.
|
inherited |
Toggle for checkpointing support.
If this is true, all changes will be added to the local changes map in the knowledge base, which is used by save_checkpoint to create diffs of knowledge
Definition at line 121 of file KnowledgeUpdateSettings.h.
|
inherited |
Toggle whether updates to global variables are treated as local variables and not marked as modified to the transport.
Definition at line 100 of file KnowledgeUpdateSettings.h.
|
inherited |
Toggle whether updates to local variables are treated as global variables that should be sent over the transport.
It should be stressed that this is dangerous and should only be used for debugging. If you toggle this to true, all local variables will be sent over the network where they will overwrite local variables in remote systems, unless the remote system filters out the local variable changes with an on-receive filter
Definition at line 138 of file KnowledgeUpdateSettings.h.