yumapro  20.10-10
YumaPro SDK
Yuma System Modules

Supports yuma-system and yumaworks-system modules. More...

Collaboration diagram for Yuma System Modules:

Macros

#define AGT_SYS_MODULE   (const xmlChar *)"yuma-system"
 older yuma-system module
 
#define AGT_YWSYS_MODULE   (const xmlChar *)"yumaworks-system"
 newerr yumaworks-system module mostly replaces yuma-system
 

Functions

status_t agt_sys_init (void)
 INIT 1: Initialize the server notification module data structures. More...
 
status_t agt_sys_init2 (void)
 INIT 2: Initialize the monitoring data structures This must be done after the <running> config is loaded. More...
 
void agt_sys_cleanup (void)
 Cleanup the module data structures. More...
 
void agt_sys_send_sysSessionStart (const ses_cb_t *scb)
 Queue the Session Start notification. More...
 
void agt_sys_send_sysSessionEnd (const ses_cb_t *scb, ses_term_reason_t termreason, ses_id_t killedby)
 Queue the Session End notification. More...
 
void agt_sys_send_sysConfigChange (const ses_cb_t *scb, dlq_hdr_t *auditrecQ)
 Queue the Config Change notification. More...
 
void agt_sys_send_sysCapabilityChange (ses_cb_t *changed_by, boolean is_add, const xmlChar *capstr)
 Send a Capability Change notification. More...
 
void agt_sys_send_sysConfirmedCommit (const ses_cb_t *scb, ncx_confirm_event_t event, uint32 timeout)
 Queue the Confirmed Commit notification. More...
 
uint32 agt_sys_get_capability_changes (void)
 Get the capability-changes counter. More...
 
val_value_tagt_sys_get_system_node (void)
 Get the /yuma-system:system container. More...
 

Detailed Description

Supports yuma-system and yumaworks-system modules.

Function Documentation

void agt_sys_cleanup ( void  )

Cleanup the module data structures.

Called by the server during shutdown.

Here is the call graph for this function:

uint32 agt_sys_get_capability_changes ( void  )

Get the capability-changes counter.

Returns
current sysCapabilityChanges counter value
val_value_t* agt_sys_get_system_node ( void  )

Get the /yuma-system:system container.

Only available if –with-yuma-system=true

Returns
pointer to container

Here is the call graph for this function:

status_t agt_sys_init ( void  )

INIT 1: Initialize the server notification module data structures.

Returns
status

Here is the call graph for this function:

Here is the caller graph for this function:

status_t agt_sys_init2 ( void  )

INIT 2: Initialize the monitoring data structures This must be done after the <running> config is loaded.

Returns
status

Here is the call graph for this function:

void agt_sys_send_sysCapabilityChange ( ses_cb_t changed_by,
boolean  is_add,
const xmlChar *  capstr 
)

Send a Capability Change notification.

Send a <sysCapabilityChange> event for a module being added

  • Send <netconf-capability-change> if –system-notifications=ietf.
  • Send <sysCapability> if –system-notifications=yuma.
  • Notification generated and added to notificationQ
Parameters
changed_bysession control block that made the change to add this module
NULL if the server made the change
is_addTRUE if the capability is being added
FALSE if the capability is being deleted
capstrcapability string that was added or deleted

Here is the call graph for this function:

Here is the caller graph for this function:

void agt_sys_send_sysConfigChange ( const ses_cb_t scb,
dlq_hdr_t *  auditrecQ 
)

Queue the Config Change notification.

  • Send <netconf-config-change> if –system-notifications=ietf.
  • Send <sysConfigChange> if –system-notifications=yuma.
  • Notification generated and added to notificationQ
Parameters
scbsession control block to use for payload values
auditrecQQ of rpc_audit_rec_t structs to use for the notification payload contents

Here is the call graph for this function:

Here is the caller graph for this function:

void agt_sys_send_sysConfirmedCommit ( const ses_cb_t scb,
ncx_confirm_event_t  event,
uint32  timeout 
)

Queue the Confirmed Commit notification.

  • Send <netconf-confirmed-commit> if –system-notifications=ietf.
  • Send <sysConfirmedCommit> if –system-notifications=yuma.
  • Notification generated and added to notificationQ
Parameters
scbsession control block to use for payload values
eventenum for the confirmEvent leaf
timeoutnumber of seconds configured for CC time out

Here is the call graph for this function:

Here is the caller graph for this function:

void agt_sys_send_sysSessionEnd ( const ses_cb_t scb,
ses_term_reason_t  termreason,
ses_id_t  killedby 
)

Queue the Session End notification.

  • Send <netconf-session-end> if –system-notifications=ietf.
  • Send <sysSessionEnd> if –system-notifications=yuma.
  • Notification generated and added to notificationQ
Parameters
scbsession control block to use for payload values
termreasonenum for the terminationReason leaf
killedbysession-id for killedBy leaf if termreason "killed"
ignored otherwise

Here is the call graph for this function:

Here is the caller graph for this function:

void agt_sys_send_sysSessionStart ( const ses_cb_t scb)

Queue the Session Start notification.

  • Send <netconf-session-start> if –system-notifications=ietf.
  • Send <sysSessionStart> if –system-notifications=yuma.
  • Notification generated and added to notificationQ
Parameters
scbsession control block to use for payload values

Here is the call graph for this function:

Here is the caller graph for this function: