Core callbacks and hooks used in the server. More...

Collaboration diagram for Core Functions:

Functions
status_t	agt_cb_register_callback (const xmlChar modname, const xmlChar defpath, const xmlChar *version, agt_cb_fn_t cbfn)
	Register an object specific edit callback function use the same fn for all callback phases all phases will be invoked. More...

status_t	agt_cb_register_edit2_callback (const xmlChar modname, const xmlChar defpath, const xmlChar *version, agt_cb_fn_t cbfn)
	Register an object specific edit2 callback function. More...

status_t	agt_cb_register_edit3_callback (const xmlChar modname, const xmlChar defpath, const xmlChar *version, agt_edit3_fn_t edit3_cbfn)
	Register an object specific edit3 callback function. More...

status_t	agt_cb_register_edit_callback_extra (const xmlChar modname, const xmlChar defpath, const xmlChar version, void cbfn, const agt_cb_extra_flags_t *extra_flags)
	Register an edit callback function with extra flags. More...

status_t	agt_cb_register_xpath_callback (const xmlChar modname, const xmlChar defpath, const xmlChar *version, xpath_bool_eval_fn_t cbfn)
	Register an object specific XPath callback function. More...

void	agt_cb_unregister_callbacks (const xmlChar modname, const xmlChar defpath)
	Unregister all EDIT callback functions for a specific object. More...

status_t	agt_cb_register_get_callback (const xmlChar modname, const xmlChar defpath, const xmlChar *version, getcb_fn2_t get_cbfn)
	Register an object specific GET callback function. More...

status_t	agt_cb_hook_register (const xmlChar *defpath, agt_hook_fmt_t format, agt_hook_type_t type, agt_cb_hook_t cbfn)
	Register an object specific Hook callback function. More...

void	agt_cb_hook_unregister (const xmlChar *defpath)
	Unregister a Hook callback. More...

status_t	agt_cb_order_hook_register (const xmlChar *defpath, agt_cb_order_hook_t cbfn)
	Register an object specific Set-Order-Hook callback function. More...

void	agt_cb_order_hook_unregister (const xmlChar *defpath)
	Unregister a Set-Order-Hook callback. More...

status_t	agt_cb_trans_start_register (agt_cb_trans_start_t cbfn)
	Register a Transaction Start callback. More...

status_t	agt_cb_trans_complete_register (agt_cb_trans_complete_t cbfn)
	Register a Transaction Complete callback. More...

void	agt_cb_trans_start_unregister (agt_cb_trans_start_t cbfn)
	Unregister a Transaction Start callback. More...

void	agt_cb_trans_complete_unregister (agt_cb_trans_complete_t cbfn)
	Unregister a Transaction Complete callback. More...

status_t	agt_cb_sa_trans_start_register (agt_cb_sa_trans_start_t cbfn)
	Register a Transaction Start callback. More...

status_t	agt_cb_sa_trans_complete_register (agt_cb_sa_trans_complete_t cbfn)
	Register a Transaction Complete callback. More...

void	agt_cb_sa_trans_start_unregister (agt_cb_sa_trans_start_t cbfn)
	Uregister a Transaction Start callback. More...

void	agt_cb_sa_trans_complete_unregister (agt_cb_sa_trans_complete_t cbfn)
	Uregister a Transaction Complete callback. More...

boolean	agt_cb_obj_has_edit_callback (obj_template_t *obj)
	Check if the specified object has a local edit callback. More...

boolean	agt_cb_obj_has_get_callback (obj_template_t *obj)
	Check if the specified object has a local get2 callback. More...

status_t	agt_cb_validate_complete_register (agt_cb_validate_complete_t cbfn)
	Register a Validate Complete callback. More...

status_t	agt_cb_startup_hook_register (agt_cb_startup_hook_t cbfn)
	Register a Startup Hook callback. More...

void	agt_cb_startup_hook_unregister (agt_cb_startup_hook_t cbfn)
	Unregister a Startup Hook callback. More...

void	agt_cb_validate_complete_unregister (agt_cb_validate_complete_t cbfn)
	Unregister a Validate Complete callback. More...

status_t	agt_cb_apply_complete_register (agt_cb_apply_complete_t cbfn)
	Register a Apply Complete callback. More...

void	agt_cb_apply_complete_unregister (agt_cb_apply_complete_t cbfn)
	Unregister a Apply Complete callback. More...

status_t	agt_cb_rollback_complete_register (agt_cb_rollback_complete_t cbfn)
	Register a Rollback Complete callback. More...

void	agt_cb_rollback_complete_unregister (agt_cb_rollback_complete_t cbfn)
	Unregister a Rollback Complete callback. More...

status_t	agt_cb_command_complete_register (agt_cb_command_complete_t cbfn)
	Register a Command Complete callback. More...

void	agt_cb_command_complete_unregister (agt_cb_command_complete_t cbfn)
	Unregister a Command Complete callback. More...

status_t	agt_cb_shutdown_register (agt_cb_shutdown_t cbfn)
	Register a Shutdown callback. More...

void	agt_cb_shutdown_unregister (agt_cb_shutdown_t cbfn)
	Unregister a Shutdown callback. More...

status_t	agt_cb_post_sethook_register (const xmlChar *defpath, agt_cb_hook_t cbfn)
	Register an object specific Post Set Hook callback function. More...

void	agt_cb_post_sethook_unregister (const xmlChar *defpath)
	Unregister a Post Set Hook callback. More...

status_t	agt_cb_session_hook_register (agt_cb_session_hook_t cbfn)
	Register a Session Hook callback. More...

void	agt_cb_session_hook_unregister (agt_cb_session_hook_t cbfn)
	Unregister a Session Hook callback. More...

status_t	agt_cb_def_hook_register (const xmlChar *defpath, ncx_def_hook_cbfn_t cbfn)
	Register an object specific Dynamic Default callback function to enable custom default value setup for a specified node. More...

void	agt_cb_def_hook_unregister (const xmlChar *defpath)
	Unregister Dynamic Default callback functions for a specific object. More...

status_t	agt_cb_sa_hook_register (const xmlChar *defpath, agt_hook_fmt_t format, agt_hook_type_t type, agt_cb_sa_hook_t cbfn)
	Register an object specific Hook callback function. More...

void	agt_cb_sa_hook_unregister (const xmlChar *defpath)
	Unregister a SIL-SA Hook SIL-SA callback. More...

status_t	agt_cb_sa_post_sethook_register (const xmlChar *defpath, agt_cb_sa_hook_t cbfn)
	Register an object specific SIL-SA Post Set Hook callback function. More...

void	agt_cb_sa_post_sethook_unregister (const xmlChar *defpath)
	Unregister a SIL-SA Post Set Hook callback. More...

status_t	agt_cb_sa_validate_complete_register (agt_cb_sa_validate_complete_t cbfn)
	Register a SIL-SA Validate Complete callback. More...

void	agt_cb_sa_validate_complete_unregister (agt_cb_sa_validate_complete_t cbfn)
	Unregister a SIL-SA Validate Complete callback. More...

status_t	agt_cb_sa_apply_complete_register (agt_cb_sa_apply_complete_t cbfn)
	Register a SIL-SA Apply Complete callback. More...

void	agt_cb_sa_apply_complete_unregister (agt_cb_sa_apply_complete_t cbfn)
	Unregister a SIL-SA Apply Complete callback. More...

status_t	agt_cb_sa_commit_complete_register (agt_cb_sa_commit_complete_t cbfn)
	Register a SIL-SA Commit Complete callback. More...

void	agt_cb_sa_commit_complete_unregister (agt_cb_sa_commit_complete_t cbfn)
	Unregister a SIL-SA Commit Complete callback. More...

status_t	agt_cb_sa_rollback_complete_register (agt_cb_sa_rollback_complete_t cbfn)
	Register a SIL-SA Rollback Complete callback. More...

void	agt_cb_sa_rollback_complete_unregister (agt_cb_sa_rollback_complete_t cbfn)
	Unregister a SIL-SA Rollback Complete callback. More...

status_t	agt_cb_edit_phase_complete_register (agt_cb_edit_phase_complete_t cbfn)
	Register an Edit Phase Complete callback. More...

void	agt_cb_edit_phase_complete_unregister (agt_cb_edit_phase_complete_t cbfn)
	Unregister an Edit Phase Complete callback. More...

status_t	agt_cb_sa_edit_phase_complete_register (agt_cb_sa_edit_phase_complete_t cbfn)
	Register a SIL-SA Edit Phase Complete callback. More...

void	agt_cb_sa_edit_phase_complete_unregister (agt_cb_sa_edit_phase_complete_t cbfn)
	Unregister a SIL-SA Edit Phase Complete callback. More...

boolean	agt_cb_any_edit_phase_complete (void)
	Return true if any edit phase complete callbacks registered. More...

boolean	agt_cb_is_skip_callback (const obj_template_t *obj, agt_cbtyp_t cbtyp)
	Determine whether the edit phase callback for the given object and callback type should be skipped based on the registered flags. More...

Detailed Description

Core callbacks and hooks used in the server.

TBD: split each hook into its own section.

Function Documentation

◆ agt_cb_any_edit_phase_complete()

boolean agt_cb_any_edit_phase_complete ( void )

Return true if any edit phase complete callbacks registered.

OK for SIL only

Returns: TRUE if any EPC callbacks registered

◆ agt_cb_apply_complete_register()

status_t agt_cb_apply_complete_register ( agt_cb_apply_complete_t cbfn )

Register a Apply Complete callback.

This function registers a Apply Complete callback that will be called right after Apply Phase has been processed during the <commit>

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_apply_complete_unregister()

void agt_cb_apply_complete_unregister ( agt_cb_apply_complete_t cbfn )

Unregister a Apply Complete callback.

This function unregisters a Apply Complete callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_command_complete_register()

status_t agt_cb_command_complete_register ( agt_cb_command_complete_t cbfn )

Register a Command Complete callback.

Max Callbacks: No limit (except available heap memory)

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_command_complete_unregister()

void agt_cb_command_complete_unregister ( agt_cb_command_complete_t cbfn )

Unregister a Command Complete callback.

This function unregisters a Command Complete callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_def_hook_register()

status_t agt_cb_def_hook_register	(	const xmlChar *	defpath,
		ncx_def_hook_cbfn_t	cbfn
	)

Register an object specific Dynamic Default callback function to enable custom default value setup for a specified node.

OK for SIL only

Parameters

defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
cbfn	address of callback function to use for Dynamic Default callbacks

Returns: status

Here is the call graph for this function:

◆ agt_cb_def_hook_unregister()

void agt_cb_def_hook_unregister ( const xmlChar * defpath )

Unregister Dynamic Default callback functions for a specific object.

OK for SIL only

Parameters

defpath definition XPath location

◆ agt_cb_edit_phase_complete_register()

status_t agt_cb_edit_phase_complete_register ( agt_cb_edit_phase_complete_t cbfn )

Register an Edit Phase Complete callback.

This function registers an Edit Phase Complete callback that will be called right after each Edit Phase has been processed during an edit transaction.

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_edit_phase_complete_unregister()

void agt_cb_edit_phase_complete_unregister ( agt_cb_edit_phase_complete_t cbfn )

Unregister an Edit Phase Complete callback.

This function unregisters an Edit Phase Complete callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_hook_register()

status_t agt_cb_hook_register	(	const xmlChar *	defpath,
		agt_hook_fmt_t	format,
		agt_hook_type_t	type,
		agt_cb_hook_t	cbfn
	)

Register an object specific Hook callback function.

OK for SIL only

Parameters

defpath	Xpath with default (or no) prefixes defining the object that will get the callback
format	different hook formats dictates specific hook functionality
type	different hook types dictates hook invocation point
cbfn	address of callback function to use for all callback phases

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_hook_unregister()

void agt_cb_hook_unregister ( const xmlChar * defpath )

Unregister a Hook callback.

This function unregisters a Hook callback.

OK for SIL only

Parameters

defpath Xpath with default (or no) prefixes defining the object that will get the callback

◆ agt_cb_is_skip_callback()

boolean agt_cb_is_skip_callback	(	const obj_template_t *	obj,
		agt_cbtyp_t	cbtyp
	)

Determine whether the edit phase callback for the given object and callback type should be skipped based on the registered flags.

Parameters

obj	pointer to the object template
cbtyp	agent callback type (e.g., AGT_CB_VALIDATE, AGT_CB_APPLY)

Returns: TRUE if the edit callback should be skipped, FALSE otherwise.

Here is the call graph for this function:

◆ agt_cb_obj_has_edit_callback()

boolean agt_cb_obj_has_edit_callback ( obj_template_t * obj )

Check if the specified object has a local edit callback.

Parameters

obj	object to check

Returns: TRUE if cbset.cbfn or edit3_cbfn set; FALSE if not

◆ agt_cb_obj_has_get_callback()

boolean agt_cb_obj_has_get_callback ( obj_template_t * obj )

Check if the specified object has a local get2 callback.

Parameters

obj	object to check

Returns: TRUE if cbset.get_cbfn set; FALSE if not

◆ agt_cb_order_hook_register()

status_t agt_cb_order_hook_register	(	const xmlChar *	defpath,
		agt_cb_order_hook_t	cbfn
	)

Register an object specific Set-Order-Hook callback function.

Needs to be registered for the list object that will be 2nd-ordered Will not be called for subtree list nodes

OK for SIL only

Parameters

defpath	Xpath with default (or no) prefixes defining the object that will get the callback
cbfn	address of callback function to use for all callback phases

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_order_hook_unregister()

void agt_cb_order_hook_unregister ( const xmlChar * defpath )

Unregister a Set-Order-Hook callback.

This function unregisters a Set-Order-Hook callback.

OK for SIL only

Parameters

defpath Xpath with default (or no) prefixes defining the object that will get the callback

◆ agt_cb_post_sethook_register()

status_t agt_cb_post_sethook_register	(	const xmlChar *	defpath,
		agt_cb_hook_t	cbfn
	)

Register an object specific Post Set Hook callback function.

OK for SIL only

Parameters

defpath	Xpath with default (or no) prefixes defining the object that will get the callback
cbfn	address of callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_post_sethook_unregister()

void agt_cb_post_sethook_unregister ( const xmlChar * defpath )

Unregister a Post Set Hook callback.

OK for SIL only

Parameters

defpath Xpath with default (or no) prefixes defining the object that will get the callback unregister

◆ agt_cb_register_callback()

status_t agt_cb_register_callback	(	const xmlChar *	modname,
		const xmlChar *	defpath,
		const xmlChar *	version,
		agt_cb_fn_t	cbfn
	)

Register an object specific edit callback function use the same fn for all callback phases all phases will be invoked.

OK for SIL or SIL-SA

Parameters

modname	module that defines the target object for these callback functions
defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
version	exact module revision date expected if condition not met then an error will be logged (TBD: force unload of module!) NULL means use any version of the module
cbfn	address of callback function to use for all callback phases

Returns: status

Here is the caller graph for this function:

◆ agt_cb_register_edit2_callback()

status_t agt_cb_register_edit2_callback	(	const xmlChar *	modname,
		const xmlChar *	defpath,
		const xmlChar *	version,
		agt_cb_fn_t	cbfn
	)

Register an object specific edit2 callback function.

Use the same fn for all callback phases all phases will be invoked

OK for SIL or SIL-SA

Only Callbacks for containers and lists are allowed in edit2 mode; Top Level Terminal Nodes are NOT SUPPORTED in edit2 mode

Parameters

modname	module that defines the target object for these callback functions
defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
version	exact module revision date expected if condition not met then an error will be logged (TBD: force unload of module!) NULL means use any version of the module
cbfn	address of callback function to use for all callback phases

Returns: status

Here is the caller graph for this function:

◆ agt_cb_register_edit3_callback()

status_t agt_cb_register_edit3_callback	(	const xmlChar *	modname,
		const xmlChar *	defpath,
		const xmlChar *	version,
		agt_edit3_fn_t	edit3_cbfn
	)

Register an object specific edit3 callback function.

Use the same fn for all callback phases all phases will be invoked

Only Callbacks for containers and lists are allowed in edit3 mode; Top Level Terminal Nodes are NOT SUPPORTED in edit3 mode

Parameters

modname	module that defines the target object for these callback functions
defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
version	exact module revision date expected if condition not met then an error will be logged (TBD: force unload of module!) NULL means use any version of the module
edit3_cbfn	address of callback function to use for all callback phases

Returns: status

◆ agt_cb_register_edit_callback_extra()

status_t agt_cb_register_edit_callback_extra	(	const xmlChar *	modname,
		const xmlChar *	defpath,
		const xmlChar *	version,
		void *	cbfn,
		const agt_cb_extra_flags_t *	extra_flags
	)

Register an edit callback function with extra flags.

Use the same callback function for all callback phases. All phases will be invoked unless specified to skip in extra_flags. The registration functions are selected based on the provided edit_cbtype in extra_flags.

Parameters

modname	module that defines the target object for these callback functions
defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
version	exact module revision date expected if condition not met then an error will be logged (TBD: force unload of module!) NULL means use any version of the module
cbfn	address of callback function to use for all callback phases
extra_flags	pointer to extra flags structure specifying options.

Returns: status

◆ agt_cb_register_get_callback()

status_t agt_cb_register_get_callback	(	const xmlChar *	modname,
		const xmlChar *	defpath,
		const xmlChar *	version,
		getcb_fn2_t	get_cbfn
	)

Register an object specific GET callback function.

Use the same fn for all callback phases all phases will be invoked

OK for SIL or SIL-SA

Parameters

modname	module that defines the target object for these callback functions
defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
version	exact module revision date expected if condition not met then an error will be logged (TBD: force unload of module!) NULL means use any version of the module
get_cbfn	address of callback function to use for GET callbacks

Returns: status

Here is the call graph for this function:

Here is the caller graph for this function:

◆ agt_cb_register_xpath_callback()

status_t agt_cb_register_xpath_callback	(	const xmlChar *	modname,
		const xmlChar *	defpath,
		const xmlChar *	version,
		xpath_bool_eval_fn_t	cbfn
	)

Register an object specific XPath callback function.

Use the same fn for all must/when stmts for the object Function must return ERR_NCX_SKIPPED if invoked for an unsupported expression.

OK for SIL only

Parameters

modname	module that defines the target object for these callback functions
defpath	Xpath with default (or no) prefixes defining the object that will get the callbacks
version	exact module revision date expected if condition not met then an error will be logged (TBD: force unload of module!) NULL means use any version of the module
cbfn	address of callback function to use

Returns: status

Here is the call graph for this function:

◆ agt_cb_rollback_complete_register()

status_t agt_cb_rollback_complete_register ( agt_cb_rollback_complete_t cbfn )

Register a Rollback Complete callback.

This function registers a Rollback Complete callback that will be called right after and if Rollback Phase has been processed during the <commit>

Max Callbacks: No limit (except available heap memory)

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_rollback_complete_unregister()

void agt_cb_rollback_complete_unregister ( agt_cb_rollback_complete_t cbfn )

Unregister a Rollback Complete callback.

This function unregisters a Rollback Complete callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_sa_apply_complete_register()

status_t agt_cb_sa_apply_complete_register ( agt_cb_sa_apply_complete_t cbfn )

Register a SIL-SA Apply Complete callback.

This function registers a SIL-SA Apply Complete callback that will be called after the Validation phase has been processed during the <commit>.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_apply_complete_unregister()

void agt_cb_sa_apply_complete_unregister ( agt_cb_sa_apply_complete_t cbfn )

Unregister a SIL-SA Apply Complete callback.

This function unregisters a SIL-SA Apply Complete callback.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Here is the call graph for this function:

◆ agt_cb_sa_commit_complete_register()

status_t agt_cb_sa_commit_complete_register ( agt_cb_sa_commit_complete_t cbfn )

Register a SIL-SA Commit Complete callback.

This function registers a SIL-SA Commit Complete callback that will be called after the Validation phase has been processed during the <commit>.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_commit_complete_unregister()

void agt_cb_sa_commit_complete_unregister ( agt_cb_sa_commit_complete_t cbfn )

Unregister a SIL-SA Commit Complete callback.

This function unregisters a SIL-SA Commit Complete callback.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Here is the call graph for this function:

◆ agt_cb_sa_edit_phase_complete_register()

status_t agt_cb_sa_edit_phase_complete_register ( agt_cb_sa_edit_phase_complete_t cbfn )

Register a SIL-SA Edit Phase Complete callback.

This function registers a SIL-SA Edit Phase Complete callback that will be called after each edit transaction phase has been processed during an edit transaction.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_edit_phase_complete_unregister()

void agt_cb_sa_edit_phase_complete_unregister ( agt_cb_sa_edit_phase_complete_t cbfn )

Unregister a SIL-SA Edit Phase Complete callback.

This function unregisters a SIL-SA Edit Phase Complete callback.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Here is the call graph for this function:

◆ agt_cb_sa_hook_register()

status_t agt_cb_sa_hook_register	(	const xmlChar *	defpath,
		agt_hook_fmt_t	format,
		agt_hook_type_t	type,
		agt_cb_sa_hook_t	cbfn
	)

Register an object specific Hook callback function.

OK for SIL-SA only

Parameters

defpath	Xpath with default (or no) prefixes defining the object that will get the callback
format	different hook formats dictates specific hook functionality
type	different hook types dictates hook invocation point
cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_hook_unregister()

void agt_cb_sa_hook_unregister ( const xmlChar * defpath )

Unregister a SIL-SA Hook SIL-SA callback.

This function unregisters a Hook callback.

OK for SIL-SA only

Parameters

defpath Xpath with default (or no) prefixes defining the object that will get the callback

◆ agt_cb_sa_post_sethook_register()

status_t agt_cb_sa_post_sethook_register	(	const xmlChar *	defpath,
		agt_cb_sa_hook_t	cbfn
	)

Register an object specific SIL-SA Post Set Hook callback function.

OK for SIL-SA only

Parameters

defpath	Xpath with default (or no) prefixes defining the object that will get the callback
cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_post_sethook_unregister()

void agt_cb_sa_post_sethook_unregister ( const xmlChar * defpath )

Unregister a SIL-SA Post Set Hook callback.

OK for SIL-SA only

Parameters

defpath Xpath with default (or no) prefixes defining the object that will get the callback unregister

◆ agt_cb_sa_rollback_complete_register()

status_t agt_cb_sa_rollback_complete_register ( agt_cb_sa_rollback_complete_t cbfn )

Register a SIL-SA Rollback Complete callback.

This function registers a SIL-SA Rollback Complete callback that will be called after the Validation phase has been processed during the <commit>.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_rollback_complete_unregister()

void agt_cb_sa_rollback_complete_unregister ( agt_cb_sa_rollback_complete_t cbfn )

Unregister a SIL-SA Rollback Complete callback.

This function unregisters a SIL-SA Rollback Complete callback.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Here is the call graph for this function:

◆ agt_cb_sa_trans_complete_register()

status_t agt_cb_sa_trans_complete_register ( agt_cb_sa_trans_complete_t cbfn )

Register a Transaction Complete callback.

This function registers a Transaction Complete callback that will be called after the transactions has been processed. This API is available only for SIL-SA Subsystem

OK for SIL-SA only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_sa_trans_complete_unregister()

void agt_cb_sa_trans_complete_unregister ( agt_cb_sa_trans_complete_t cbfn )

Uregister a Transaction Complete callback.

Uregister a Transaction Complete callback. This API is available only for SIL-SA Subsystem

OK for SIL-SA only

Parameters

cbfn	address of callback function to unregister

Here is the call graph for this function:

◆ agt_cb_sa_trans_start_register()

status_t agt_cb_sa_trans_start_register ( agt_cb_sa_trans_start_t cbfn )

Register a Transaction Start callback.

This function registers a Transaction Start callback that will be called before any changes to the candidate database will be committed when the transaction is getting initialized. This API is available only for SIL-SA Subsystem

OK for SIL-SA only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_sa_trans_start_unregister()

void agt_cb_sa_trans_start_unregister ( agt_cb_sa_trans_start_t cbfn )

Uregister a Transaction Start callback.

This function unregisters a Transaction Start callback. This API is available only for SIL-SA Subsystem

OK for SIL-SA only

Parameters

cbfn	address of callback function to unregister

Here is the call graph for this function:

◆ agt_cb_sa_validate_complete_register()

status_t agt_cb_sa_validate_complete_register ( agt_cb_sa_validate_complete_t cbfn )

Register a SIL-SA Validate Complete callback.

This function registers a SIL-SA Validate Complete callback that will be called after the Validation phase has been processed during the <commit>.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_sa_validate_complete_unregister()

void agt_cb_sa_validate_complete_unregister ( agt_cb_sa_validate_complete_t cbfn )

Unregister a SIL-SA Validate Complete callback.

This function unregisters a SIL-SA Validate Complete callback.

OK for SIL-SA only

Parameters

cbfn	address of SIL-SA callback function to use

Here is the call graph for this function:

◆ agt_cb_session_hook_register()

status_t agt_cb_session_hook_register ( agt_cb_session_hook_t cbfn )

Register a Session Hook callback.

Max Callbacks: No limit (except available heap memory)

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_session_hook_unregister()

void agt_cb_session_hook_unregister ( agt_cb_session_hook_t cbfn )

Unregister a Session Hook callback.

This function unregisters a Session Hook callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_shutdown_register()

status_t agt_cb_shutdown_register ( agt_cb_shutdown_t cbfn )

Register a Shutdown callback.

Max Callbacks: No limit (except available heap memory)

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_shutdown_unregister()

void agt_cb_shutdown_unregister ( agt_cb_shutdown_t cbfn )

Unregister a Shutdown callback.

This function unregisters a Shutdown callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_startup_hook_register()

status_t agt_cb_startup_hook_register ( agt_cb_startup_hook_t cbfn )

Register a Startup Hook callback.

This function registers a Startup Hook callback that will be called before any changes to the startup file/database.

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_startup_hook_unregister()

void agt_cb_startup_hook_unregister ( agt_cb_startup_hook_t cbfn )

Unregister a Startup Hook callback.

This function unregisters a Startup Hook callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_trans_complete_register()

status_t agt_cb_trans_complete_register ( agt_cb_trans_complete_t cbfn )

Register a Transaction Complete callback.

This function registers a Transaction Complete callback that will be called after the transactions has been processed.

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation

Here is the call graph for this function:

◆ agt_cb_trans_complete_unregister()

void agt_cb_trans_complete_unregister ( agt_cb_trans_complete_t cbfn )

Unregister a Transaction Complete callback.

This function unregisters a Transaction Complete callback.

OK for SIL only

Parameters

cbfn	address of callback function to unregister

Here is the call graph for this function:

◆ agt_cb_trans_start_register()

status_t agt_cb_trans_start_register ( agt_cb_trans_start_t cbfn )

Register a Transaction Start callback.

This function registers a Transaction Start callback that will be called before any changes to the candidate database will be committed when the transaction is getting initialized.

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_trans_start_unregister()

void agt_cb_trans_start_unregister ( agt_cb_trans_start_t cbfn )

Unregister a Transaction Start callback.

This function unregisters a Transaction Start callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function:

◆ agt_cb_unregister_callbacks()

void agt_cb_unregister_callbacks	(	const xmlChar *	modname,
		const xmlChar *	defpath
	)

Unregister all EDIT callback functions for a specific object.

OK for SIL or SIL-SA

Parameters

modname	module containing the object for this callback
defpath	definition XPath location

Here is the call graph for this function:

Here is the caller graph for this function:

◆ agt_cb_validate_complete_register()

status_t agt_cb_validate_complete_register ( agt_cb_validate_complete_t cbfn )

Register a Validate Complete callback.

This function registers a Validate Complete callback that will be called after the Validation phase has been processed during the <commit>.

OK for SIL only

Parameters

cbfn	address of callback function to use

Returns: the status of the operation.

Here is the call graph for this function:

◆ agt_cb_validate_complete_unregister()

void agt_cb_validate_complete_unregister ( agt_cb_validate_complete_t cbfn )

Unregister a Validate Complete callback.

This function unregisters a Validate Complete callback.

OK for SIL only

Parameters

cbfn	address of callback function to use

Here is the call graph for this function: