Settings to control YANG warnings. More...

Collaboration diagram for Settings:

Functions
void	ncx_set_warn_idlen (uint32 warnlen)
	Set the warning length for identifiers. More...

uint32	ncx_get_warn_idlen (void)
	Get the warning length for identifiers. More...

void	ncx_set_warn_linelen (uint32 warnlen)
	Set the warning length for YANG file lines. More...

uint32	ncx_get_warn_linelen (void)
	Get the warning length for YANG file lines. More...

void	ncx_check_warn_idlen (tk_chain_t tkc, ncx_module_t mod, const xmlChar *id)
	Check if the identifier length is greater than the specified amount. More...

void	ncx_check_warn_linelen (tk_chain_t tkc, ncx_module_t mod, const xmlChar *line)
	Check if the line display length is greater than the specified amount. More...

status_t	ncx_turn_off_warning (status_t res)
	Add a warning suppression entry. More...

status_t	ncx_turn_on_warning (status_t res)
	Remove a warning suppression entry if it exists. More...

status_t	ncx_turn_up_warning (status_t res)
	Add a warning elevation entry. More...

void	ncx_set_warn_error (boolean val)
	Set the warn_error flag. More...

void	ncx_set_warn_off_yang (boolean val)
	Set the warn_off_yang flag. More...

boolean	ncx_get_warn_off_yang (void)
	Get the warn_off_yang flag. More...

boolean	ncx_warning_enabled (status_t res)
	Check if a specific status_t code is enabled. More...

boolean	ncx_warning_elevated (status_t res)
	Check if a specific status_t code is elevated. More...

void	ncx_delete_all_obsolete_objects (void)
	Go through all the modules and delete the obsolete nodes. More...

void	ncx_set_top_mandatory_allowed (boolean allowed)
	Allow or disallow modules with top-level mandatory object to be loaded; used by the server when agt_running_error is TRUE. More...

boolean	ncx_get_top_mandatory_allowed (void)
	Check if top-level mandatory objects are allowed or not. More...

boolean	ncx_collapse_submodules_ok (void)
	Check if it is OK to collapse submodule definitions into the main module. More...

void	ncx_set_module_setid (uint32 new_setid)
	Update YANG-LIBRARY module set ID. More...

uint32	ncx_get_module_setid (void)
	GET YANG-LIBRARY module set ID. More...

status_t	ncx_sprintf_module_setid (uint32 id, xmlChar *buff, int32 buffsize)
	Write the module set ID for the yang-library to the specified buffer. More...

boolean	ncx_get_empty_npcon_presence (void)
	Get the empty_npcon_presence value. More...

void	ncx_set_empty_npcon_presence (boolean val)
	Set the empty_npcon_presence value. More...

boolean	ncx_get_empty_npcon_presence_ro (void)
	Get the empty_npcon_presence value READ-ONLY check. More...

void	ncx_set_empty_npcon_presence_ro (boolean val)
	Set the empty_npcon_presence value READ-ONLY check. More...

Detailed Description

Settings to control YANG warnings.

Compiler warnings can be raised to errors and also turned off completely.

Function Documentation

◆ ncx_check_warn_idlen()

void ncx_check_warn_idlen	(	tk_chain_t *	tkc,
		ncx_module_t *	mod,
		const xmlChar *	id
	)

Check if the identifier length is greater than the specified amount.

Parameters

tkc	token chain to use (for warning message only)
mod	module (for warning message only)
id	identifier string to check; must be Z terminated

Note: May generate log_warn ouput

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ncx_check_warn_linelen()

void ncx_check_warn_linelen	(	tk_chain_t *	tkc,
		ncx_module_t *	mod,
		const xmlChar *	line
	)

Check if the line display length is greater than the specified amount.

Parameters

tkc	token chain to use
mod	module (used in warning message only
line	line to check

Note: May generate log_warn ouput

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ncx_collapse_submodules_ok()

boolean ncx_collapse_submodules_ok ( void )

Check if it is OK to collapse submodule definitions into the main module.

Used by the server to make data access more efficient

Returns: TRUE if OK; FALSE if not

See also: ncx_collapse_submod_defs

◆ ncx_delete_all_obsolete_objects()

void ncx_delete_all_obsolete_objects ( void )

Go through all the modules and delete the obsolete nodes.

This is not a setting. Used by the server to scrub unused objects when the server starts up

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ncx_get_empty_npcon_presence()

boolean ncx_get_empty_npcon_presence ( void )

Get the empty_npcon_presence value.

Returns: TRUE if Empty NP containers should be created; FALSE if should not

Here is the caller graph for this function:

◆ ncx_get_empty_npcon_presence_ro()

boolean ncx_get_empty_npcon_presence_ro ( void )

Get the empty_npcon_presence value READ-ONLY check.

Set the empty_npcon_presence value exception for RO child nodes

Returns: TRUE if Empty NP containers if no defaults but there are direct read-only child nodes
FALSE if should not

Here is the caller graph for this function:

◆ ncx_get_module_setid()

uint32 ncx_get_module_setid ( void )

GET YANG-LIBRARY module set ID.

Returns: module set ID value

Here is the caller graph for this function:

◆ ncx_get_top_mandatory_allowed()

boolean ncx_get_top_mandatory_allowed ( void )

Check if top-level mandatory objects are allowed or not.

Returns: TRUE: allowed; FALSE: disallowed

See also: ncx_set_top_mandatory_allowed

◆ ncx_get_warn_idlen()

uint32 ncx_get_warn_idlen ( void )

Get the warning length for identifiers.

Returns: warning length to use

◆ ncx_get_warn_linelen()

uint32 ncx_get_warn_linelen ( void )

Get the warning length for YANG file lines.

Returns: warning length to use

◆ ncx_get_warn_off_yang()

boolean ncx_get_warn_off_yang ( void )

Get the warn_off_yang flag.

Returns: Value of the –warn-off-yang CLI parameter

Here is the caller graph for this function:

◆ ncx_set_empty_npcon_presence()

void ncx_set_empty_npcon_presence ( boolean val )

Set the empty_npcon_presence value.

Parameters

val	TRUE if Empty NP containers should be created; FALSE if should not

Here is the caller graph for this function:

◆ ncx_set_empty_npcon_presence_ro()

void ncx_set_empty_npcon_presence_ro ( boolean val )

Set the empty_npcon_presence value READ-ONLY check.

This value SHOULD be set to true. Default is FALSE for backward compatibility with older releases

Parameters

val	TRUE if Empty NP containers if no defaults but there are direct read-only child nodes FALSE if should not

Here is the caller graph for this function:

◆ ncx_set_module_setid()

void ncx_set_module_setid ( uint32 new_setid )

Update YANG-LIBRARY module set ID.

Parameters

new_setid module-set-id calue to keep

◆ ncx_set_top_mandatory_allowed()

void ncx_set_top_mandatory_allowed ( boolean allowed )

Allow or disallow modules with top-level mandatory object to be loaded; used by the server when agt_running_error is TRUE.

There are msome OpenConfig and other modules that have mandatory leafs nested within NP-containers, which creates a top-level mandatory object. The server parameters –startup-error=continue and –running-error=continue are usually used for such modules

An invalid configuration needs to be fixed by an operator before an edit-config or commit to running will be accepted

Parameters

allowed value to set T: to allow; F: to disallow

See also: ncx_get_top_mandatory_allowed

Here is the caller graph for this function:

◆ ncx_set_warn_error()

void ncx_set_warn_error ( boolean val )

Set the warn_error flag.

Parameters

val	value to set

Here is the caller graph for this function:

◆ ncx_set_warn_idlen()

void ncx_set_warn_idlen ( uint32 warnlen )

Set the warning length for identifiers.

Parameters

warnlen warning length to use

Here is the caller graph for this function:

◆ ncx_set_warn_linelen()

void ncx_set_warn_linelen ( uint32 warnlen )

Set the warning length for YANG file lines.

Parameters

warnlen warning length to use

Here is the caller graph for this function:

◆ ncx_set_warn_off_yang()

void ncx_set_warn_off_yang ( boolean val )

Set the warn_off_yang flag.

Parameters

val	value to set

Here is the caller graph for this function:

◆ ncx_sprintf_module_setid()

status_t ncx_sprintf_module_setid	(	uint32	id,
		xmlChar *	buff,
		int32	buffsize
	)

Write the module set ID for the yang-library to the specified buffer.

Parameters

	id	module set id to use
[out]	buff	buffer to use buff filled in if big enough
	buffsize	buffer size to use

Returns: status

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ncx_turn_off_warning()

status_t ncx_turn_off_warning ( status_t res )

Add a warning suppression entry.

Parameters

res	internal status code to suppress

Returns: status (duplicates are silently dropped)

Here is the caller graph for this function:

◆ ncx_turn_on_warning()

status_t ncx_turn_on_warning ( status_t res )

Remove a warning suppression entry if it exists.

Parameters

res	internal status code to enable

Returns: status (duplicates are silently dropped)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ncx_turn_up_warning()

status_t ncx_turn_up_warning ( status_t res )

Add a warning elevation entry.

Parameters

res	internal status code to suppress

Returns: status (duplicates are silently dropped)

Here is the caller graph for this function:

◆ ncx_warning_elevated()

boolean ncx_warning_elevated ( status_t res )

Check if a specific status_t code is elevated.

Parameters

res	internal status code to check

Returns: TRUE if warning is elevated to error; FALSE if warning is not elevated

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ncx_warning_enabled()

boolean ncx_warning_enabled ( status_t res )

Check if a specific status_t code is enabled.

Parameters

res	internal status code to check

Returns: TRUE if warning is enabled; FALSE if warning is suppressed

Here is the call graph for this function:

Here is the caller graph for this function:

Functions

Detailed Description

Function Documentation

◆ ncx_check_warn_idlen()

◆ ncx_check_warn_linelen()

◆ ncx_collapse_submodules_ok()

◆ ncx_delete_all_obsolete_objects()

◆ ncx_get_empty_npcon_presence()

◆ ncx_get_empty_npcon_presence_ro()

◆ ncx_get_module_setid()

◆ ncx_get_top_mandatory_allowed()

◆ ncx_get_warn_idlen()

◆ ncx_get_warn_linelen()

◆ ncx_get_warn_off_yang()

◆ ncx_set_empty_npcon_presence()

◆ ncx_set_empty_npcon_presence_ro()

◆ ncx_set_module_setid()

◆ ncx_set_top_mandatory_allowed()

◆ ncx_set_warn_error()

◆ ncx_set_warn_idlen()

◆ ncx_set_warn_linelen()

◆ ncx_set_warn_off_yang()

◆ ncx_sprintf_module_setid()

◆ ncx_turn_off_warning()

◆ ncx_turn_on_warning()

◆ ncx_turn_up_warning()

◆ ncx_warning_elevated()

◆ ncx_warning_enabled()