Macros and data structures used to manage YANG instrumentation callbacks and hooks. More...

Collaboration diagram for Data Structures:

Data Structures
struct	agt_cb_subsys_t
	header for 1 subsystem that has a SIL-SA callback function registered for the data node in the agt_cb_set_t struct containing the subsysQ More...

struct	agt_cb_extra_flags_t
	Structure to hold extra flags for callback registration. More...

struct	agt_cb_fnset_t
	set of server object callback functions back pointer to this struct stored in obj_template_t Shared by local and subsys callbacks More...

struct	agt_editcb_t
	EDIT Control Block used to store all the pointers for the EDIT3 callbacks. More...

Macros
#define	FORALL TRUE
	symbolic tag for agt_cb_register_callback 'forall' boolean

#define	FORONE FALSE
	symbolic tag for agt_cb_register_callback 'forone' boolean

#define	AGT_CB_FL_EDIT bit0
	begin 3 flags for the agt_cb_subsys_t.flags field edit flag indicates EDIT1 callbacks for this subsystem

#define	AGT_CB_FL_GET bit1
	GET2 callbacks for this subsystem.

#define	AGT_CB_FL_EDIT2 bit2
	EDIT2 callbacks for this subsystem.

#define	AGT_CB_FL_PSHOOK bit3
	3 flags for the HOOKS support in agt_cb_subsys_t.flags field More...

#define	AGT_CB_FL_SHOOK bit4
	Set Hook.

#define	AGT_CB_FL_TXHOOK bit5
	Transaction Hook.

#define	AGT_CB_FL_SETHOOK_TREE bit0
	4 flags for the agt_cb_fnset_t.flags field More...

#define	AGT_CB_FL_TRANSHOOK_TREE bit1
	transaction hook tree

#define	AGT_CB_FL_SKIP_SETHOOK bit2
	skip set-hook

#define	AGT_CB_FL_SKIP_TRANSHOOK bit3
	skip transaction hook

#define	AGT_CB_FL_PSETHOOK bit4
	Specifies whether post-set-hook is set in the cbset.

#define	AGT_CB_FL_SETHOOK bit5
	Specifies whether set-hook is set in the cbset.

#define	AGT_CB_FL_TRANSHOOK bit6
	Specifies whether transaction-hook is set in the cbset.

#define	AGT_CB_FL_EDIT3 bit7
	EDIT3 callbacks for this subsystem.

#define	AGT_CB_FL_SKIP_VALIDATE bit8
	skip validate phase

#define	AGT_CB_FL_SKIP_APPLY bit9
	skip apply phase

#define	AGT_CB_SUBSYS_HAS_EDIT(S) ((S)->flags & AGT_CB_FL_EDIT)
	check subsystem has an EDIT1 callback

#define	AGT_CB_SUBSYS_HAS_GET(S) ((S)->flags & AGT_CB_FL_GET)
	check subsystem has a GET2 callback

#define	AGT_CB_SUBSYS_HAS_EDIT2(S) ((S)->flags & AGT_CB_FL_EDIT2)
	check subsystem has an EDIT2 callback

#define	AGT_CB_SUBSYS_HAS_EDIT3(S) ((S)->flags & AGT_CB_FL_EDIT3)
	check subsystem has an EDIT3 callback

#define	AGT_CB_SUBSYS_HAS_PSHOOK(S) ((S)->flags & AGT_CB_FL_PSHOOK)
	Hooks Support flags handling check subsystem has a post-set-hook.

#define	AGT_CB_SUBSYS_HAS_SHOOK(S) ((S)->flags & AGT_CB_FL_SHOOK)
	check subsystem has a set-hook

#define	AGT_CB_SUBSYS_HAS_TXHOOK(S) ((S)->flags & AGT_CB_FL_TXHOOK)
	check subsystem has a transaction-hook

#define	AGT_CB_SUBSYS_SET_PSHOOK(S) (S)->flags \|= AGT_CB_FL_PSHOOK
	set subsystem has a post-set-hook

#define	AGT_CB_SUBSYS_SET_SHOOK(S) (S)->flags \|= AGT_CB_FL_SHOOK
	set subsystem has a set-hook

#define	AGT_CB_SUBSYS_SET_TXHOOK(S) (S)->flags \|= AGT_CB_FL_TXHOOK
	set subsystem has a transaction-hook

#define	AGT_CB_HAS_REMOTE_PSHOOK(C) ((C)->flags & AGT_CB_FL_PSETHOOK)
	Flags to tell the server that the CBSET has remote hook callbacks check subsystem has a remote post-set-hook.

#define	AGT_CB_HAS_REMOTE_SHOOK(C) ((C)->flags & AGT_CB_FL_SETHOOK)
	check subsystem has a remote set-hook

#define	AGT_CB_HAS_REMOTE_TXHOOK(C) ((C)->flags & AGT_CB_FL_TRANSHOOK)
	check subsystem has a remote transaction-hook

#define	AGT_CB_SET_REMOTE_PSHOOK(C) (C)->flags \|= AGT_CB_FL_PSETHOOK
	set remote has a post-set-hook

#define	AGT_CB_SET_REMOTE_SHOOK(C) (C)->flags \|= AGT_CB_FL_SETHOOK
	set remote has a set-hook

#define	AGT_CB_SET_REMOTE_TXHOOK(C) (C)->flags \|= AGT_CB_FL_TRANSHOOK
	set remote has a transaction-hook

#define	AGT_CB_HAS_SKIP_VALIDATE(C) ((C)->flags & AGT_CB_FL_SKIP_VALIDATE)
	Flags to check if the phase callback is skipped in the CBSET. More...

#define	AGT_CB_SET_SKIP_VALIDATE(C) (C)->flags \|= AGT_CB_FL_SKIP_VALIDATE
	set the phase callback to be skipped

Typedefs
typedef status_t(*	agt_cb_fn_t) (ses_cb_t scb, rpc_msg_t msg, agt_cbtyp_t cbtyp, op_editop_t editop, val_value_t newval, val_value_t curval)
	EDIT1 and EDIT2 Callback function for server object handler. More...

typedef status_t(*	agt_cb_hook_t) (ses_cb_t scb, rpc_msg_t msg, agt_cfg_transaction_t txcb, op_editop_t editop, val_value_t newval, val_value_t *curval)
	Typedef of the agt_cb_hook_t callback. More...

typedef uint8(*	agt_cb_order_hook_t) (agt_cfg_transaction_t txcb, op_editop_t editop, val_value_t newval, val_value_t curval, status_t res)
	Typedef of the agt_order_hook_cb callback. More...

typedef status_t(*	agt_cb_trans_start_t) (agt_cfg_transaction_t *txcb)
	Typedef of the trans_start callback. More...

typedef status_t(*	agt_cb_sa_trans_start_t) (const xmlChar *transaction_id, boolean isvalidate, boolean isrollback, boolean isrunning)
	Typedef of the sa_trans_start callback. More...

typedef void(*	agt_cb_trans_complete_t) (agt_cfg_transaction_t *txcb)
	Typedef of the trans_complete callback. More...

typedef void(*	agt_cb_sa_trans_complete_t) (const xmlChar *transaction_id_val)
	Typedef of the sa_trans_complete callback. More...

typedef status_t(*	agt_cb_startup_hook_t) (ses_cb_t scb, rpc_msg_t msg, cfg_template_t source_config, cfg_template_t target_config)
	Typedef of the agt_cb_startup_hook_t callback. More...

typedef status_t(*	agt_cb_validate_complete_t) (ses_cb_t scb, rpc_msg_t msg, val_value_t candidate, val_value_t running)
	Typedef of the agt_cb_validate_complete_t callback. More...

typedef status_t(*	agt_cb_sa_validate_complete_t) (const xmlChar *transaction_id)
	Typedef of the agt_cb_sa_validate_complete_t callback. More...

typedef status_t(*	agt_cb_apply_complete_t) (ses_cb_t scb, rpc_msg_t msg, val_value_t candidate, val_value_t running)
	Typedef of the agt_cb_apply_complete_t callback. More...

typedef status_t(*	agt_cb_sa_apply_complete_t) (const xmlChar *transaction_id)
	Typedef of the agt_cb_sa_apply_complete_t callback. More...

typedef status_t(*	agt_cb_rollback_complete_t) (ses_cb_t scb, rpc_msg_t msg, val_value_t candidate, val_value_t running)
	Typedef of the agt_cb_rollback_complete_t callback. More...

typedef status_t(*	agt_cb_sa_rollback_complete_t) (const xmlChar *transaction_id)
	Typedef of the agt_cb_sa_rollback_complete_t callback. More...

typedef status_t(*	agt_cb_sa_commit_complete_t) (const xmlChar *transaction_id, agt_commit_type_t commit_type)
	Typedef of the agt_cb_sa_commit_complete_t callback. More...

typedef void(*	agt_cb_command_complete_t) (ses_cb_t scb, rpc_msg_t msg, const xmlChar command_modname, const xmlChar command_name)
	Typedef of the agt_command_complete_cb_t callback. More...

typedef void(*	agt_cb_shutdown_t) (void)
	Typedef of the agt_cb_shutdown_t callback. More...

typedef void(*	agt_cb_session_hook_t) (ncx_ses_event_t ses_event, const ses_cb_t *scb)
	Typedef of the agt_cb_session_hook_t callback. More...

typedef status_t(*	agt_cb_sa_hook_t) (ses_cb_t scb, rpc_msg_t msg, op_editop_t editop, val_value_t newval, val_value_t curval, const xmlChar *transaction_id, boolean isvalidate, boolean isload, boolean isrunning)
	Typedef of the SIL-SA version of agt_cb_hook_t callback. More...

typedef status_t(*	agt_cb_edit_phase_complete_t) (agt_cbtyp_t edit_phase, ses_cb_t scb, rpc_msg_t msg, val_value_t source, val_value_t target)
	Typedef of the agt_cb_edit_phase_complete_t callback. More...

typedef status_t(*	agt_cb_sa_edit_phase_complete_t) (agt_cbtyp_t edit_phase, const xmlChar *transaction_id)
	Typedef of the agt_cb_sa_edit_phase_complete_t callback. More...

typedef status_t(*	agt_edit3_fn_t) (agt_editcb_t *editcb)
	EDIT3 Callback function for server object handler. More...

Enumerations
enum	agt_cb_calltype_t { AGT_CB_CALLTYPE_NONE , AGT_CB_CALLTYPE_EDIT , AGT_CB_CALLTYPE_EDIT2 , AGT_CB_CALLTYPE_EDIT3 , AGT_CB_CALLTYPE_GET }
	different data node callback types for SIL and SIL-SA to register More...

enum	agt_edit_cbtype_t { AGT_EDIT_CBTYPE_NONE = 0 , AGT_EDIT_CBTYPE_EDIT , AGT_EDIT_CBTYPE_EDIT2 , AGT_EDIT_CBTYPE_EDIT3 }
	Enumeration for EDIT callback types for SIL and SIL-SA to register. More...

Detailed Description

Macros and data structures used to manage YANG instrumentation callbacks and hooks.

Registration is done when the YANG module SIL or SIL-SA code is loaded.

Macro Definition Documentation

◆ AGT_CB_FL_PSHOOK

#define AGT_CB_FL_PSHOOK bit3

3 flags for the HOOKS support in agt_cb_subsys_t.flags field

Post Set Hook

◆ AGT_CB_FL_SETHOOK_TREE

#define AGT_CB_FL_SETHOOK_TREE bit0

4 flags for the agt_cb_fnset_t.flags field

set-hook tree

◆ AGT_CB_HAS_SKIP_VALIDATE

#define AGT_CB_HAS_SKIP_VALIDATE ( C ) ((C)->flags & AGT_CB_FL_SKIP_VALIDATE)

Flags to check if the phase callback is skipped in the CBSET.

check if the phase callback is skipped

Typedef Documentation

◆ agt_cb_apply_complete_t

typedef status_t(* agt_cb_apply_complete_t) (ses_cb_t *scb, rpc_msg_t *msg, val_value_t *candidate, val_value_t *running)

Typedef of the agt_cb_apply_complete_t callback.

The Apply Complete callback is the user/system callback that is invoked after the Validate Phase has been processed during the <commit> operation.

The Validate Complete is object independent and module independent which means you don't have to link them to the specific object as it's done for EDIT or GET callbacks, and you don't have to link them to any specific module

Max Callbacks: No limit (except available heap memory)

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
candidate	candidate val_value_t for the config database to use
running	running val_value_t for the config database to use

Returns: status

◆ agt_cb_command_complete_t

typedef void(* agt_cb_command_complete_t) (ses_cb_t *scb, rpc_msg_t *msg, const xmlChar *command_modname, const xmlChar *command_name)

Typedef of the agt_command_complete_cb_t callback.

The Command Complete callback is the user/system callback that is invoked after each client command is executed for the NETCONF or RESTCONF protocols.

The Command Complete is typically used for retrieval operations (get, get-config, get-bulk) to release resources used during GET2 callbacks invoked during the operation.

Max Callbacks: No limit (except available heap memory)

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
command_modname	YANG module name of command that is completed
command_name	YANG RPC object name of command that is completed

◆ agt_cb_edit_phase_complete_t

typedef status_t(* agt_cb_edit_phase_complete_t) (agt_cbtyp_t edit_phase, ses_cb_t *scb, rpc_msg_t *msg, val_value_t *source, val_value_t *target)

Typedef of the agt_cb_edit_phase_complete_t callback.

The Edit Phase Complete callback is the user/system callback that is invoked after each edit transaction phase has been processed during any edit transaction operation.

Edit phases are defined in agt_cbtyp_t enumeration

Callbacks for the AGT_CB_VALIDATE phase may be invoked for the <candidate> or <running> datastore.

Callbacks for the other phases may be invoked for the <running> datastore.

If the return value is not NO_ERR then the edit transaction will be terminated and a rollback will begin.

Max Callbacks: No limit (except available heap memory)

Parameters

edit_phase	edit phase enumeration that has just been completed
scb	session control block making the request
msg	incoming rpc_msg_t in progress
source	val_value_t for the source config database to use
target	val_value_t for the target config database to use

Returns: status

◆ agt_cb_fn_t

typedef status_t(* agt_cb_fn_t) (ses_cb_t *scb, rpc_msg_t *msg, agt_cbtyp_t cbtyp, op_editop_t editop, val_value_t *newval, val_value_t *curval)

EDIT1 and EDIT2 Callback function for server object handler.

Used to provide a callback sub-mode for a specific named object

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
cbtyp	reason for the callback
editop	the parent edit-config operation type, which is also used for all other callbacks that operate on objects
newval	container object holding the proposed changes to apply to the current config, depending on the editop value. Will not be NULL.
curval	current container values from the <running> or <candidate> configuration, if any. Could be NULL for create and other operations.

Returns: status

◆ agt_cb_hook_t

typedef status_t(* agt_cb_hook_t) (ses_cb_t *scb, rpc_msg_t *msg, agt_cfg_transaction_t *txcb, op_editop_t editop, val_value_t *newval, val_value_t *curval)

Typedef of the agt_cb_hook_t callback.

Callback function for server object handler Used to provide a callback for a specific named object

Set Hook: Similar to the EDIT1 or EDIT2 callbacks, except this callback is only invoked once at the start of the edit for a particular data node. This callback can alter the data in the current edit and also add new edits to the current transaction. This callback will be invoked before a EDIT1 or EDIT2 callback for the same object.

Post Set Hook: Is a postponed Set Hook callback analogous function that is invoked within the transaction when an object is modified but AFTER EDIT callback is done for the same object. This callback will be invoked AFTER a EDIT1 or EDIT2 callback for the same object.

Transaction Hook: Similar to a Set Hook except this callback is invoked just before the data is committed to the running datastore. This callback will be invoked after a EDIT1 or EDIT2 callbacks for the same object.

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
txcb	transaction control block in progress
editop	edit operation enumeration for the node being edited
newval	container object holding the proposed changes to apply to the current config, depending on the editop value. Will not be NULL.
curval	current container values from the <running> or <candidate> configuration, if any. Could be NULL for create and other operations.

Returns: status

◆ agt_cb_order_hook_t

typedef uint8(* agt_cb_order_hook_t) (agt_cfg_transaction_t *txcb, op_editop_t editop, val_value_t *newval, val_value_t *curval, status_t *res)

Typedef of the agt_order_hook_cb callback.

Callback function for server object handler Used to provide a callback for a specific named object

Set-Order-Hook: Invoked in document order for each edited instance of the specified object. The callback needs to return the desired secondary SIL priority for the specific list instance

This callback is invoked once per edited instance and after any Set Hook is called for the object and instance.

Parameters

	txcb	transaction control block in progress
	editop	edit operation enumeration for the node being edited
	newval	container object holding the proposed changes to apply to the current config, depending on the editop value. Will not be NULL.
	curval	current container values from the <running> or <candidate> configuration, if any. Could be NULL for create and other operations.
[out]	res	address of return status *res status of callback; status error will cause the transaction to be terminated and rollback started

Returns: the secondary SIL priority to assign to the object instance

◆ agt_cb_rollback_complete_t

typedef status_t(* agt_cb_rollback_complete_t) (ses_cb_t *scb, rpc_msg_t *msg, val_value_t *candidate, val_value_t *running)

Typedef of the agt_cb_rollback_complete_t callback.

The Rollback Complete callback is the user/system callback that is invoked after and if the Rollback Phase has been processed during the <commit> operation.

The Rollback Complete is object independent and module independent which means you don't have to link them to the specific object as it's done for EDIT or GET callbacks, and you don't have to link them to any specific module.

Max Callbacks: No limit (except available heap memory)

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
candidate	candidate val_value_t for the config database to use
running	running val_value_t for the config database to use

Returns: status

◆ agt_cb_sa_apply_complete_t

typedef status_t(* agt_cb_sa_apply_complete_t) (const xmlChar *transaction_id)

Typedef of the agt_cb_sa_apply_complete_t callback.

The SIL-SA Apply Complete callback is the user/system callback that is invoked after the Apply Phase has been processed during the <commit> operation.

SIL-SA Version

Max Callbacks: No limit (except available heap memory)

Parameters

transaction_id transaction ID in progress

Returns: status

◆ agt_cb_sa_commit_complete_t

typedef status_t(* agt_cb_sa_commit_complete_t) (const xmlChar *transaction_id, agt_commit_type_t commit_type)

Typedef of the agt_cb_sa_commit_complete_t callback.

The SIL-SA Commit Complete callback is the user/system callback that is invoked after the Commit Phase has been processed during the <commit> operation.

SIL-SA Version

Max Callbacks: No limit (except available heap memory)

Parameters

transaction_id	transaction ID in progress
commit_type	commit type; only if phase is Commit

Returns: status

◆ agt_cb_sa_edit_phase_complete_t

typedef status_t(* agt_cb_sa_edit_phase_complete_t) (agt_cbtyp_t edit_phase, const xmlChar *transaction_id)

Typedef of the agt_cb_sa_edit_phase_complete_t callback.

The SIL-SA Edit Phase Complete callback is the user/system callback that is invoked after each Edit Phase has been processed during any edit transaction.

SIL-SA Version

Max Callbacks: No limit (except available heap memory)

Parameters

edit_phase	edit-phase in progress
transaction_id	transaction ID in progress

Returns: status

◆ agt_cb_sa_hook_t

typedef status_t(* agt_cb_sa_hook_t) (ses_cb_t *scb, rpc_msg_t *msg, op_editop_t editop, val_value_t *newval, val_value_t *curval, const xmlChar *transaction_id, boolean isvalidate, boolean isload, boolean isrunning)

Typedef of the SIL-SA version of agt_cb_hook_t callback.

Callback function for server object handler Used to provide a callback for a specific named object

Set Hook: Similar to the EDIT1 or EDIT2 callbacks, except this callback is only invoked once at the start of the edit for a particular data node. This callback can alter the data in the current edit and also add new edits to the current transaction. This callback will be invoked before a EDIT1 or EDIT2 callback for the same object.

Post Set Hook: Is a postponed Set Hook callback analogous function that is invoked within the transaction when an object is modified but AFTER EDIT callback is done for the same object. This callback will be invoked AFTER a EDIT1 or EDIT2 callback for the same object.

Transaction Hook: Similar to a Set Hook except this callback is invoked just before the data is committed to the running datastore. This callback will be invoked after a EDIT1 or EDIT2 callbacks for the same object.

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
editop	edit operation enumeration for the node being edited
newval	container object holding the proposed changes to apply to the current config, depending on the editop value. Will not be NULL.
curval	current container values from the <running> or <candidate> configuration, if any. Could be NULL for create and other operations.
transaction_id	transaction ID of the transaction control block in progress
isvalidate	TRUE if this Transaction is for <validate> operation
isload	TRUE if this Transaction is for a Load operation
isrunning	TRUE if this Transaction is for the the running datastore

Returns: status

◆ agt_cb_sa_rollback_complete_t

typedef status_t(* agt_cb_sa_rollback_complete_t) (const xmlChar *transaction_id)

Typedef of the agt_cb_sa_rollback_complete_t callback.

The SIL-SA Rollback Complete callback is the user/system callback that is invoked after and if the Rollback Phase has been processed during the <commit> operation.

SIL-SA Version

Max Callbacks: No limit (except available heap memory)

Parameters

transaction_id transaction ID in progress

Returns: status

◆ agt_cb_sa_trans_complete_t

typedef void(* agt_cb_sa_trans_complete_t) (const xmlChar *transaction_id_val)

Typedef of the sa_trans_complete callback.

The Complete Transaction function is the user/system callback that is invoked at the end of the transaction This is for SIL-SA subsystem only

Max Callbacks: No limit (except available heap memory)

Parameters

transaction_id_val transaction ID in progress

◆ agt_cb_sa_trans_start_t

typedef status_t(* agt_cb_sa_trans_start_t) (const xmlChar *transaction_id, boolean isvalidate, boolean isrollback, boolean isrunning)

Typedef of the sa_trans_start callback.

The Start Transaction function is the user/system callback that is invoked before any changes to the candidate database will be committed. This is for SIL-SA subsystem only

Max Callbacks: No limit (except available heap memory)

Parameters

transaction_id	transaction ID in progress
isvalidate	TRUE if this is Transaction is for Validate
isrollback	TRUE if this is Transaction for Rollback or Load
isrunning	TRUE if running datastore is being modified

Returns: status

◆ agt_cb_sa_validate_complete_t

typedef status_t(* agt_cb_sa_validate_complete_t) (const xmlChar *transaction_id)

Typedef of the agt_cb_sa_validate_complete_t callback.

The SIL-SA Validate Complete callback is the user/system callback that is invoked after the Validate Phase has been processed during the <commit> operation.

SIL-SA Version

Max Callbacks: No limit (except available heap memory)

Parameters

transaction_id transaction ID in progress

Returns: status

◆ agt_cb_session_hook_t

typedef void(* agt_cb_session_hook_t) (ncx_ses_event_t ses_event, const ses_cb_t *scb)

Typedef of the agt_cb_session_hook_t callback.

The Session Hook callback is invoked when a session starts and ends. Use ses.h macros like SES_MY_USERNAME(scb) to get data like client username. Max Callbacks: No limit (except available heap memory)

Parameters

ses_event	session event type
scb	session control block for the session event

◆ agt_cb_shutdown_t

typedef void(* agt_cb_shutdown_t) (void)

Typedef of the agt_cb_shutdown_t callback.

The Shutdown callback is the user/system callback that is invoked at the start of a normal agt_cleanup A normal shutdown or restart is in progress. This callback is not invoked if the server crashes.

Max Callbacks: No limit (except available heap memory)

◆ agt_cb_startup_hook_t

typedef status_t(* agt_cb_startup_hook_t) (ses_cb_t *scb, rpc_msg_t *msg, cfg_template_t *source_config, cfg_template_t *target_config)

Typedef of the agt_cb_startup_hook_t callback.

The Startup Hook callback is the user/system callback that is invoked right before the <startup> is getting modified.

The Startup Hook is object independent and module independent which means you don't have to link them to the specific object as it's done for EDIT or GET callbacks, and you don't have to link them to any specific module

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
source_config	datastore which is being copied
target_config	datastore that is being edited

Returns: status

◆ agt_cb_trans_complete_t

typedef void(* agt_cb_trans_complete_t) (agt_cfg_transaction_t *txcb)

Typedef of the trans_complete callback.

The Transaction Complete function is the user/system callback that is invoked after the transactions has been processed.

Max Callbacks: No limit (except available heap memory) 1 Per SIL

Parameters

txcb	transaction control block in progress

◆ agt_cb_trans_start_t

typedef status_t(* agt_cb_trans_start_t) (agt_cfg_transaction_t *txcb)

Typedef of the trans_start callback.

The Start Transaction function is the user/system callback that is invoked before any changes to the candidate database will be committed.

Max Callbacks: No limit (except available heap memory)

Parameters

txcb	transaction control block in progress

Returns: status

◆ agt_cb_validate_complete_t

typedef status_t(* agt_cb_validate_complete_t) (ses_cb_t *scb, rpc_msg_t *msg, val_value_t *candidate, val_value_t *running)

Typedef of the agt_cb_validate_complete_t callback.

The Validate Complete callback is the user/system callback that is invoked after the Validate Phase has been processed during the <commit> operation.

The Validate Complete is object independent and module independent which means you don't have to link them to the specific object as it's done for EDIT or GET callbacks, and you don't have to link them to any specific module

Max Callbacks: No limit (except available heap memory)

Parameters

scb	session control block making the request
msg	incoming rpc_msg_t in progress
candidate	candidate val_value_t for the config database to use
running	running val_value_t for the config database to use

Returns: status

◆ agt_edit3_fn_t

typedef status_t(* agt_edit3_fn_t) (agt_editcb_t *editcb)

EDIT3 Callback function for server object handler.

Used to provide a callback sub-mode for a specific named complex object

Parameters

editcb Edit Control Block that contains full EDIT3 callback information

Returns: status:

Enumeration Type Documentation

◆ agt_cb_calltype_t

enum agt_cb_calltype_t

different data node callback types for SIL and SIL-SA to register

Enumerator
AGT_CB_CALLTYPE_NONE	not set
AGT_CB_CALLTYPE_EDIT	EDIT1 callback.
AGT_CB_CALLTYPE_EDIT2	EDIT2 callback.
AGT_CB_CALLTYPE_EDIT3	EDIT3 callback.
AGT_CB_CALLTYPE_GET	GET2 callback.

◆ agt_edit_cbtype_t

enum agt_edit_cbtype_t

Enumeration for EDIT callback types for SIL and SIL-SA to register.

Enumerator
AGT_EDIT_CBTYPE_NONE	not set
AGT_EDIT_CBTYPE_EDIT	EDIT callback type.
AGT_EDIT_CBTYPE_EDIT2	EDIT2 callback type.
AGT_EDIT_CBTYPE_EDIT3	EDIT3 callback type.

Data Structures

Macros

Typedefs

Enumerations

Detailed Description

Macro Definition Documentation

◆ AGT_CB_FL_PSHOOK

◆ AGT_CB_FL_SETHOOK_TREE

◆ AGT_CB_HAS_SKIP_VALIDATE

Typedef Documentation

◆ agt_cb_apply_complete_t

◆ agt_cb_command_complete_t

◆ agt_cb_edit_phase_complete_t

◆ agt_cb_fn_t

◆ agt_cb_hook_t

◆ agt_cb_order_hook_t

◆ agt_cb_rollback_complete_t

◆ agt_cb_sa_apply_complete_t

◆ agt_cb_sa_commit_complete_t

◆ agt_cb_sa_edit_phase_complete_t

◆ agt_cb_sa_hook_t

◆ agt_cb_sa_rollback_complete_t

◆ agt_cb_sa_trans_complete_t

◆ agt_cb_sa_trans_start_t

◆ agt_cb_sa_validate_complete_t

◆ agt_cb_session_hook_t

◆ agt_cb_shutdown_t

◆ agt_cb_startup_hook_t

◆ agt_cb_trans_complete_t

◆ agt_cb_trans_start_t

◆ agt_cb_validate_complete_t

◆ agt_edit3_fn_t

Enumeration Type Documentation

◆ agt_cb_calltype_t

◆ agt_edit_cbtype_t