yumapro  20.10-10
YumaPro SDK
Callback Functions

SIL-SA callback functions are written for specific YANG objects. More...

Collaboration diagram for Callback Functions:

Functions

status_t sil_call_load_code (sil_sa_cb_t *cb)
 Load the SIL-SA library code for the modules and bundles in the <register-repsonse> message. More...
 
status_t sil_call_load_one (sil_sa_cb_t *cb, const xmlChar *name, boolean is_module)
 Load the SIL-SA library code for one module or bundle. More...
 
status_t sil_call_edit_phase (sil_sa_cb_t *cb, agt_cbtyp_t cbtyp, ses_cb_t *scb)
 Invoke 1 phase of the edit procedure. More...
 
void sil_call_clean_profile (sil_sa_cb_t *cb)
 Clean the module-specific data from the profile. More...
 
void sil_call_init (void)
 Init the module. More...
 
void sil_call_cleanup (void)
 Cleanup the module. More...
 
void sil_call_free_bundle_cb (sil_sa_bundle_t *buncb)
 Clean and free a bundle control block. More...
 
dlq_hdr_t * sil_call_get_bundle_modQ (void)
 Get the bundle modQ. More...
 
boolean sil_call_check_bundle_duplicate (sil_sa_cb_t *cb, const xmlChar *modname)
 Check for a module already claimed in a bundle. More...
 

Detailed Description

SIL-SA callback functions are written for specific YANG objects.

Libraries for modules or bundles are loaded during registration. A module or bundle could be loaded or unloaded at runtime by a client. SIL-SA Callbacks are invoked through the APIs in this module.

All functions in this module are user APIs for subsystem use only!

Function Documentation

boolean sil_call_check_bundle_duplicate ( sil_sa_cb_t cb,
const xmlChar *  modname 
)

Check for a module already claimed in a bundle.

Parameters
cbcontrol block to use
modnamemodule name to check
Returns
TRUE if it is a duplicate; FALSE if not

Here is the call graph for this function:

Here is the caller graph for this function:

void sil_call_clean_profile ( sil_sa_cb_t cb)

Clean the module-specific data from the profile.

Parameters
cbsil_sa control block to clean

Here is the call graph for this function:

void sil_call_cleanup ( void  )

Cleanup the module.

Called when the subsystem shuts down. Could be because the application is exiting or the server shut down. Must be called before the YControl shutdown.

Here is the call graph for this function:

status_t sil_call_edit_phase ( sil_sa_cb_t cb,
agt_cbtyp_t  cbtyp,
ses_cb_t scb 
)

Invoke 1 phase of the edit procedure.

Parameters
cbSIL-SA control block to use to read and write state
cbtypcallback type enumeration
scbSIL-SA session control block used for this transaction
Returns
status

Here is the call graph for this function:

void sil_call_free_bundle_cb ( sil_sa_bundle_t buncb)

Clean and free a bundle control block.

Parameters
buncbbundle control block to clean and free
dlq_hdr_t* sil_call_get_bundle_modQ ( void  )

Get the bundle modQ.

Needed to generate messages back to the server.

Returns
bundle mod Q
void sil_call_init ( void  )

Init the module.

Called when the application starts. The YControl layer must be initialized first.

Here is the call graph for this function:

Here is the caller graph for this function:

status_t sil_call_load_code ( sil_sa_cb_t cb)

Load the SIL-SA library code for the modules and bundles in the <register-repsonse> message.

Parameters
cbSIL-SA control block to use to read and write state
Returns
status

Here is the call graph for this function:

status_t sil_call_load_one ( sil_sa_cb_t cb,
const xmlChar *  name,
boolean  is_module 
)

Load the SIL-SA library code for one module or bundle.

Parameters
cbcontrol block to use
namemodule or bundle name
is_moduleTRUE for module; FALSE for bundle
Returns
status

Here is the call graph for this function: