yumapro  20.10-14
YumaPro SDK
Debugging Utilities

Internal Heap Checking. More...

Collaboration diagram for Debugging Utilities:

Typedefs

typedef status_t(* support_save_cbfn_t) (ses_cb_t *scb, xml_msg_hdr_t *mhdr, xmlns_id_t parent_nsid, const xmlChar *subtree_name, int32 indent, int32 startindent)
 Support Save Callback Function Used to add info to the support-save report. More...
 

Functions

void heapcheck_init (void)
 Initialize heap checking module. More...
 
void heapcheck_report (boolean use_logger, log_debug_t level, const char *label)
 Generate a heap check report. More...
 
void heapcheck_set_hold_free (boolean hold)
 Internal function do not use. More...
 
void heapcheck_release_held_free (boolean hold)
 Internal release held free Do not use. More...
 
status_t support_save_init (void)
 Load the yumaworks-support-save module. More...
 
status_t support_save_init2 (void)
 Load the yumaworks-support-save module (phase 2) More...
 
void support_save_cleanup (void)
 Cleanup the support_save module. More...
 
status_t support_save_register_cbfn (const xmlChar *subtree_name, support_save_cbfn_t subtree_cbfn)
 Register a support-save callback function. More...
 
status_t support_save_write (ses_cb_t *scb, xml_msg_hdr_t *mhdr, int32 indent, int32 startindent)
 Write the support save information to the specified session Use the registered callbacks in the order they are registered. More...
 
boolean support_save_is_active (void)
 Check if a support-save is in progress. More...
 
obj_template_tsupport_save_get_object (void)
 Get the support-save-data object template. More...
 

Detailed Description

Internal Heap Checking.

The C define HEAP_CHECKING must be enabled for this code to be present in the server image.

Typedef Documentation

◆ support_save_cbfn_t

typedef status_t(* support_save_cbfn_t) (ses_cb_t *scb, xml_msg_hdr_t *mhdr, xmlns_id_t parent_nsid, const xmlChar *subtree_name, int32 indent, int32 startindent)

Support Save Callback Function Used to add info to the support-save report.

Parameters
scbsession for output
mhdrXML message header to use
parent_nsidnamespace ID for parent object
subtree_namename being called for (allows callback reuse)
indentindent increment (-1 for no increment)
startindentcurrent indent amount to use
Returns
status

Function Documentation

◆ heapcheck_init()

void heapcheck_init ( void  )

Initialize heap checking module.

◆ heapcheck_release_held_free()

void heapcheck_release_held_free ( boolean  hold)

Internal release held free Do not use.

Parameters
holdHold flag for internal use

◆ heapcheck_report()

void heapcheck_report ( boolean  use_logger,
log_debug_t  level,
const char *  label 
)

Generate a heap check report.

Parameters
use_loggerTRUE to use log output
leveldebug level needed to generate report
labelstring to print before report

◆ heapcheck_set_hold_free()

void heapcheck_set_hold_free ( boolean  hold)

Internal function do not use.

Parameters
holdInternal flag

◆ support_save_cleanup()

void support_save_cleanup ( void  )

Cleanup the support_save module.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ support_save_get_object()

obj_template_t* support_save_get_object ( void  )

Get the support-save-data object template.

Returns
pointer to object or NULL if not available

◆ support_save_init()

status_t support_save_init ( void  )

Load the yumaworks-support-save module.

Returns
status
Here is the call graph for this function:

◆ support_save_init2()

status_t support_save_init2 ( void  )

Load the yumaworks-support-save module (phase 2)

Returns
status
Here is the call graph for this function:
Here is the caller graph for this function:

◆ support_save_is_active()

boolean support_save_is_active ( void  )

Check if a support-save is in progress.

Returns
TRUE if active; FALSE if not

◆ support_save_register_cbfn()

status_t support_save_register_cbfn ( const xmlChar *  subtree_name,
support_save_cbfn_t  subtree_cbfn 
)

Register a support-save callback function.

This function is responsible for generating an XML subtree by using xml_wr functions for the provided session

Parameters
subtree_namename of the YANG object that will be added
subtree_cbfncallback function pointer
Returns
status
Here is the call graph for this function:

◆ support_save_write()

status_t support_save_write ( ses_cb_t scb,
xml_msg_hdr_t mhdr,
int32  indent,
int32  startindent 
)

Write the support save information to the specified session Use the registered callbacks in the order they are registered.

Parameters
scbsession to use
mhdrmessage header to use
indentindent increment amount
startindentstart message indent amount
Returns
status
Here is the call graph for this function: