yumapro  23.10T-7
YumaPro SDK
Loading...
Searching...
No Matches
Configuration Edit Data Structures

Data structures to manage edit transaction state. More...

Collaboration diagram for Configuration Edit Data Structures:

Data Structures

struct  agt_cfg_transaction_t
 Transaction Control Block. More...
 
struct  agt_cfg_nested_silcall_t
 struct of data for 1 nested SIL callback within 1 undo. More...
 
struct  agt_cfg_undo_rec_t
 struct of params to undo an edit operation. More...
 
struct  agt_cfg_child_silcall_t
 struct of data for 1 children of one remote SIL callback More...
 
struct  agt_cfg_silcall_t
 struct of data for 1 remote SIL callback More...
 
struct  agt_cfg_audit_rec_t
 struct of params to use when generating sysConfigChange notification. More...
 
struct  agt_cfg_commit_test_t
 struct for the commit-time tests for a single object More...
 
struct  agt_cfg_xpath_visit_t
 struct to keep track of XPath tests run in this transaction More...
 
struct  agt_cfg_trans_hook_t
 struct of Transaction Hooks parameters More...
 

Macros

#define AGT_CFG_SET_VALIDATE_DEF(C)   (C)->is_validate_def = TRUE
 set the validate-only flag
 
#define AGT_CFG_GET_VALIDATE_DEF(C)   (C)->is_validate_def
 check the validate-only flag
 
#define AGT_CFG_SET_SKIP_SIL(C)   (C)->skip_sil = TRUE
 set the skip SIL callback flag
 
#define AGT_CFG_GET_SKIP_SIL(C)   (C)->skip_sil
 check the skip SIL callback flag
 
#define AGT_CFG_SET_SKIP_SIL_PARTIAL(C)   (C)->skip_sil_partial = TRUE
 set the skip SIL partial callback flag
 
#define AGT_CFG_GET_SKIP_SIL_PARTIAL(C)   (C)->skip_sil_partial
 check the skip SIL partial callback flag
 
#define AGT_CFG_SET_SKIP_SAVE(C)   (C)->skip_save = TRUE
 set the skip save flag
 
#define AGT_CFG_GET_SKIP_SAVE(C)   (C)->skip_save
 check the skip save flag
 
#define AGT_CFG_GET_COMMENT(C)   (C)->comment
 get the transaction comment
 
#define AGT_CFG_SET_COMMENT(C, S)   (C)->comment = S
 set the transaction comment
 
#define AGT_CFG_GET_TXCB(M)   (M)->rpc_txcb
 rpc_msg_t has a pointer to the transaction in progress for that message
 
#define AGT_CFG_SET_CUR_SILCALL(C, S)   (C)->cur_silcall = S
 set the current SIL callback
 
#define AGT_CFG_GET_CUR_SILCALL(C)   (C)->cur_silcall
 get the current SIL callback
 
#define AGT_CFG_SET_TOP_REPLACE(C)   (C)->top_replace = TRUE
 set the top replace mode
 
#define AGT_CFG_IS_TOP_REPLACE(C)   (C)->top_replace
 check the top replace mode
 
#define AGT_CFG_NEWMPIDQ(C)   &((C)->newmpidQ)
 access the newmpidQ of backptrs
 
#define AGT_CFG_CHECK_REDO(C)   (C)->check_redo_root_check
 access the check_redo_root_check
 
#define AGT_CFG_IS_CC_TIMEOUT(C)   (C)->is_cc_timeout
 access the confirmed-commit timeout flag
 
#define AGT_CFG_TEST_ONLY_CLEANUP(C)   (C)->test_only_cleanup
 access the test_only_cleanup flag
 

Enumerations

enum  agt_cfg_edit_action_t {
  AGT_CFG_EDIT_ACTION_NONE ,
  AGT_CFG_EDIT_ACTION_ADD ,
  AGT_CFG_EDIT_ACTION_SET ,
  AGT_CFG_EDIT_ACTION_MOVE ,
  AGT_CFG_EDIT_ACTION_REPLACE ,
  AGT_CFG_EDIT_ACTION_DELETE ,
  AGT_CFG_EDIT_ACTION_DELETE_DEFAULT
}
 classify the config edit action type More...
 
enum  agt_cfg_edit_type_t {
  AGT_CFG_EDIT_TYPE_NONE ,
  AGT_CFG_EDIT_TYPE_FULL ,
  AGT_CFG_EDIT_TYPE_PARTIAL
}
 classify the config edit type More...
 

Detailed Description

Data structures to manage edit transaction state.

The agt_cfg_transaction_t is the main structure for managing an edit transaction.

Enumeration Type Documentation

◆ agt_cfg_edit_action_t

classify the config edit action type

Enumerator
AGT_CFG_EDIT_ACTION_NONE 

not set

AGT_CFG_EDIT_ACTION_ADD 

add edit action

AGT_CFG_EDIT_ACTION_SET 

set edit action

AGT_CFG_EDIT_ACTION_MOVE 

move edit action

AGT_CFG_EDIT_ACTION_REPLACE 

replace edit action

AGT_CFG_EDIT_ACTION_DELETE 

delete edit action

AGT_CFG_EDIT_ACTION_DELETE_DEFAULT 

delete default edit action

◆ agt_cfg_edit_type_t

classify the config edit type

Enumerator
AGT_CFG_EDIT_TYPE_NONE 

not set

AGT_CFG_EDIT_TYPE_FULL 

REPLACE = full database replace.

AGT_CFG_EDIT_TYPE_PARTIAL 

REPLACE = subtree replace.