yumapro  23.10T-8
YumaPro SDK
Loading...
Searching...
No Matches
Global SIL callbacks

Global Server callbacks to integrate vendor instrumentation into the YANG module processing. More...

Collaboration diagram for Global SIL callbacks:

Data Structures

struct  agt_glob_cbset_t
 the Global Control Block stores a set of callbacks for each Global Callback [RPC, Action, EDIT2, EDIT3, GET2] More...
 

Functions

status_t agt_glob_init (void)
 Initialize the Action handler. More...
 
void agt_glob_cleanup (void)
 Cleanup the Global handler. More...
 
agt_glob_cbset_tagt_glob_get_cbset (void)
 Get the Global Cbset structure. More...
 
agt_rpc_method_tagt_glob_get_rpc_cbfn (obj_template_t *obj)
 Find RPC callback function if any for a specific OBJ. More...
 
agt_action_cb_tagt_glob_get_action_cbfn (obj_template_t *obj)
 Find Action callback function if any for a specific OBJ. More...
 
agt_cb_fn_t agt_glob_get_edit2_cbfn (obj_template_t *obj)
 Find EDIT2 callback function if any for a specific OBJ. More...
 
agt_edit3_fn_t agt_glob_get_edit3_cbfn (obj_template_t *obj)
 Find EDIT3 callback function if any for a specific OBJ. More...
 
boolean agt_glob_has_rpc_callback (obj_template_t *obj)
 Check there is RPC callback. More...
 
boolean agt_glob_has_action_callback (obj_template_t *obj)
 Check there is Action callback. More...
 
boolean agt_glob_has_edit_callback (obj_template_t *obj)
 Check there is EDIT2 or EDIT3 callback. More...
 
status_t agt_glob_register_rpc (agt_rpc_phase_t phase, agt_rpc_method_t cbfn)
 add callback for 1 phase of RPC processing More...
 
void agt_glob_unregister_rpc (void)
 Unregister Global RPC callbacks. More...
 
status_t agt_glob_register_action (agt_rpc_phase_t phase, agt_action_cb_t action_cb)
 add callback for 1 phase of Global Action processing More...
 
void agt_glob_unregister_action (void)
 remove all Global callbacks for all phases of action processing More...
 
status_t agt_glob_register_edit2 (agt_cb_fn_t cbfn)
 Register a Global EDIT2 callback. More...
 
status_t agt_glob_register_edit3 (agt_edit3_fn_t cbfn)
 Register a Global EDIT3 callback. More...
 
void agt_glob_unregister_edit (void)
 Unregister Global EDIT callbacks. More...
 
status_t agt_glob_register_get (getcb_fn2_t cbfn)
 Register a Global GET2 callback. More...
 
void agt_glob_unregister_get (void)
 Unregister Global GET2 callbacks. More...
 

Detailed Description

Global Server callbacks to integrate vendor instrumentation into the YANG module processing.

Function Documentation

◆ agt_glob_cleanup()

void agt_glob_cleanup ( void  )

Cleanup the Global handler.

INTERNAL API

Cleanup the Global handler

◆ agt_glob_get_action_cbfn()

agt_action_cb_t * agt_glob_get_action_cbfn ( obj_template_t obj)

Find Action callback function if any for a specific OBJ.

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
cbfn for the specified obj if any.
Here is the call graph for this function:

◆ agt_glob_get_cbset()

agt_glob_cbset_t * agt_glob_get_cbset ( void  )

Get the Global Cbset structure.

INTERNAL API

Returns
Global Cbset structure
Here is the caller graph for this function:

◆ agt_glob_get_edit2_cbfn()

agt_cb_fn_t agt_glob_get_edit2_cbfn ( obj_template_t obj)

Find EDIT2 callback function if any for a specific OBJ.

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
cbfn for the specified obj if any.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ agt_glob_get_edit3_cbfn()

agt_edit3_fn_t agt_glob_get_edit3_cbfn ( obj_template_t obj)

Find EDIT3 callback function if any for a specific OBJ.

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
cbfn for the specified obj if any.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ agt_glob_get_rpc_cbfn()

agt_rpc_method_t * agt_glob_get_rpc_cbfn ( obj_template_t obj)

Find RPC callback function if any for a specific OBJ.

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
cbfn for the specified obj if any.
Here is the call graph for this function:

◆ agt_glob_has_action_callback()

boolean agt_glob_has_action_callback ( obj_template_t obj)

Check there is Action callback.

Check if the OBJ has any callbacks setup for it; Global or registered OBJ specific.

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
TRUE if the OBJ has local Action callback setup for it

◆ agt_glob_has_edit_callback()

boolean agt_glob_has_edit_callback ( obj_template_t obj)

Check there is EDIT2 or EDIT3 callback.

Check if the OBJ has EDIT2 or EDIT3 callbacks setup for it

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
TRUE if the OBJ has local EDIT callback setup for it Can be EDIT, EDIT2, EDIT3 or Global EDIT2 or EDIT2 cbs
Here is the call graph for this function:
Here is the caller graph for this function:

◆ agt_glob_has_rpc_callback()

boolean agt_glob_has_rpc_callback ( obj_template_t obj)

Check there is RPC callback.

Check if the OBJ has any callbacks setup for it; Global or registered OBJ specific.

INTERNAL API

Parameters
objthe obj_template_t to check
Returns
TRUE if the OBJ has local RPC callback setup for it

◆ agt_glob_init()

status_t agt_glob_init ( void  )

Initialize the Action handler.

INTERNAL API

Returns
status of the initialization procedure
Here is the caller graph for this function:

◆ agt_glob_register_action()

status_t agt_glob_register_action ( agt_rpc_phase_t  phase,
agt_action_cb_t  action_cb 
)

add callback for 1 phase of Global Action processing

Parameters
phaseaction server callback phase for this callback
  • AGT_PH_VALIDATE(0): validate phase
  • AGT_PH_INVOKE(1): invoke phase
  • AGT_PH_POST_REPLY(2): post-reply phase
action_cbpointer to callback function to register
Returns
status of the operation
Here is the call graph for this function:

◆ agt_glob_register_edit2()

status_t agt_glob_register_edit2 ( agt_cb_fn_t  cbfn)

Register a Global EDIT2 callback.

This function registers a Global EDIT2 callback that will be called if there are no any other EDIT2 or EDIT3 callbacks registered to the current target object.

Parameters
cbfnaddress of EDIT2 callback function to use
Returns
the status of operation
Here is the call graph for this function:

◆ agt_glob_register_edit3()

status_t agt_glob_register_edit3 ( agt_edit3_fn_t  cbfn)

Register a Global EDIT3 callback.

This function registers a Global EDIT3 callback that will be called if there are no any other EDIT3 or EDIT2 callbacks registered to the current target object.

Parameters
cbfnaddress of EDIT3 callback function to use
Returns
the status of operation
Here is the call graph for this function:

◆ agt_glob_register_get()

status_t agt_glob_register_get ( getcb_fn2_t  cbfn)

Register a Global GET2 callback.

This function registers a Global GET2 callback that will be called if there are no any other GET2 callbacks registered to the current target object.

Parameters
cbfnaddress of GET2 callback function to use
Returns
the status of operation
Here is the call graph for this function:

◆ agt_glob_register_rpc()

status_t agt_glob_register_rpc ( agt_rpc_phase_t  phase,
agt_rpc_method_t  cbfn 
)

add callback for 1 phase of RPC processing

This function registers a Global RPC callback that will be called if there are no any other RPC callbacks registered to the current RPC target object.

Parameters
phaseRPC server callback phase for this callback
  • AGT_PH_VALIDATE(0): validate phase
  • AGT_PH_INVOKE(1): invoke phase
  • AGT_PH_POST_REPLY(2): post-reply phase
cbfnpointer to callback function to register
Returns
status of the operation
Here is the call graph for this function:

◆ agt_glob_unregister_action()

void agt_glob_unregister_action ( void  )

remove all Global callbacks for all phases of action processing

Here is the call graph for this function:

◆ agt_glob_unregister_edit()

void agt_glob_unregister_edit ( void  )

Unregister Global EDIT callbacks.

This function unregisters Global EDIT callbacks.

Here is the call graph for this function:

◆ agt_glob_unregister_get()

void agt_glob_unregister_get ( void  )

Unregister Global GET2 callbacks.

This function unregisters Global GET2 callbacks.

Here is the call graph for this function:

◆ agt_glob_unregister_rpc()

void agt_glob_unregister_rpc ( void  )

Unregister Global RPC callbacks.

This function unregisters Global RPC callbacks. All methods

Here is the call graph for this function: