Schema Item Identifier assignment mapping dictionary. More...

Collaboration diagram for YANG SID Dictionary:

Functions
status_t	sid_dict_init (void)
	Initialize the YANG SID dictionary. More...

status_t	sid_dict_init_write (void)
	Initialize the YANG SID dictionary for writing a SID DICT file. More...

void	sid_dict_cleanup (void)
	Cleanup the YANG SID dictionary. More...

void	sid_dict_cleanup_write (void)
	Cleanup the YANG SID dictionary for writing a SID DICT file. More...

status_t	sid_dict_add_data (uint32 id, obj_template_t *obj, boolean internal)
	Store a data item in the SID item dict. More...

boolean	sid_dict_remove_data (uint32 id, obj_template_t *obj)
	Remove a data object from the SID item dict. More...

status_t	sid_dict_find_data (uint32 id, ncx_sid_t sid, obj_template_t **obj)
	Find a data item in the SID item dictionary. More...

status_t	sid_dict_add_module (uint32 id, ncx_module_t *mod, boolean internal)
	Store a module item in the SID item dict. More...

boolean	sid_dict_remove_module (uint32 id, ncx_module_t *mod)
	Remove a module object from the SID item dict. More...

status_t	sid_dict_find_module (uint32 id, ncx_sid_t sid, ncx_module_t **mod)
	Find a module item in the SID item dictionary. More...

status_t	sid_dict_add_identity (uint32 id, ncx_identity_t *ident, boolean internal)
	Store an identity item in the SID item dict. More...

boolean	sid_dict_remove_identity (uint32 id, ncx_identity_t *ident)
	Remove an identity object from the SID item dict. More...

status_t	sid_dict_find_identity (uint32 id, ncx_sid_t sid, ncx_identity_t **ident)
	Find an identity item in the SID item dictionary. More...

status_t	sid_dict_add_feature (uint32 id, ncx_feature_t *feat, boolean internal)
	Store a feature item in the SID item dict. More...

boolean	sid_dict_remove_feature (uint32 id, ncx_feature_t *feat)
	Remove a feature identity object from the SID item dict. More...

status_t	sid_dict_find_feature (uint32 id, ncx_sid_t sid, ncx_feature_t **feat)
	Find a feature item in the SID item dictionary. More...

status_t	sid_dict_add_module_write (ncx_module_t mod, uint32 retcnt)
	Store all the entries for a module for writing. More...

status_t	sid_dict_walk_module_write (sid_dict_walk_cbfn_t cbfn, void *cookie)
	Walk the SID WRITE tree to generate item entries. More...

void	sid_dict_dump (uint32 id)
	Print the sorted dictionary contents. More...

void	sid_dict_write_dump (void)
	Print the sorted dictionary contents WRITE TREE. More...

void	sid_dict_xml_wr (ses_cb_t scb, xml_msg_hdr_t mhdr, obj_template_t *obj, boolean external_only, xmlns_id_t parent_nsid, ncx_sid_t start_sid, ncx_sid_t stop_sid, int32 indent)
	Print the sorted dictionary contents for the yumaworks-yang-cbor get-yang-sid-info RPC operation. More...

ncx_sid_t	sid_dict_highest (void)
	Get the highest SID number. More...

uint32	sid_dict_count (void)
	Get the current count of SID numbers. More...

status_t	sid_dict_new (uint32 *id)
	Allocate a new SID tree for a session. More...

void	sid_dict_free (uint32 id)
	Free a SID tree previously allocated with sid_dict_new. More...

Detailed Description

Schema Item Identifier assignment mapping dictionary.

Used for quick lookup of YANG schema items by the SID number. Used by cbor_parse to lookup objects and identities.

Function Documentation

◆ sid_dict_add_data()

status_t sid_dict_add_data	(	uint32	id,
		obj_template_t *	obj,
		boolean	internal
	)

Store a data item in the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
obj	object to add
internal	TRUE if internal item; FALSE if visible to all

Returns: status

◆ sid_dict_add_feature()

status_t sid_dict_add_feature	(	uint32	id,
		ncx_feature_t *	feat,
		boolean	internal
	)

Store a feature item in the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
feat	feature to add
internal	TRUE if internal item; FALSE if visible to all

Returns: status

◆ sid_dict_add_identity()

status_t sid_dict_add_identity	(	uint32	id,
		ncx_identity_t *	ident,
		boolean	internal
	)

Store an identity item in the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
ident	identity to add
internal	TRUE if internal item; FALSE if visible to all

Returns: status

◆ sid_dict_add_module()

status_t sid_dict_add_module	(	uint32	id,
		ncx_module_t *	mod,
		boolean	internal
	)

Store a module item in the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
mod	module to add
internal	TRUE if internal item; FALSE if visible to all

Returns: status

Here is the caller graph for this function:

◆ sid_dict_add_module_write()

status_t sid_dict_add_module_write	(	ncx_module_t *	mod,
		uint32 *	retcnt
	)

Store all the entries for a module for writing.

Must call sid_dict_init_write first
All the identifiers are sorted by their namespace
No SIDs are assigned yet
Used to get the sorted item list so SIDs can be assigned

Parameters

	mod	module to add
[out]	retcnt	number of SIDs used by this module

Returns: status

Here is the call graph for this function:

◆ sid_dict_cleanup()

void sid_dict_cleanup ( void )

Cleanup the YANG SID dictionary.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sid_dict_cleanup_write()

void sid_dict_cleanup_write ( void )

Cleanup the YANG SID dictionary for writing a SID DICT file.

◆ sid_dict_count()

uint32 sid_dict_count ( void )

Get the current count of SID numbers.

Returns: number of SIDs currently assigned

◆ sid_dict_dump()

void sid_dict_dump ( uint32 id )

Print the sorted dictionary contents.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)

Here is the caller graph for this function:

◆ sid_dict_find_data()

status_t sid_dict_find_data	(	uint32	id,
		ncx_sid_t	sid,
		obj_template_t **	obj
	)

Find a data item in the SID item dictionary.

Parameters

	id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
	sid	SID of the data item to find
[out]	obj	address of return object *obj found object

Returns: status

◆ sid_dict_find_feature()

status_t sid_dict_find_feature	(	uint32	id,
		ncx_sid_t	sid,
		ncx_feature_t **	feat
	)

Find a feature item in the SID item dictionary.

Parameters

	id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
	sid	SID of the feature item to find
[out]	feat	address of return feature *feat found feature

Returns: status

◆ sid_dict_find_identity()

status_t sid_dict_find_identity	(	uint32	id,
		ncx_sid_t	sid,
		ncx_identity_t **	ident
	)

Find an identity item in the SID item dictionary.

Parameters

	id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
	sid	SID of the identity item to find
[out]	ident	address of return identity *ident found identity

Returns: status

◆ sid_dict_find_module()

status_t sid_dict_find_module	(	uint32	id,
		ncx_sid_t	sid,
		ncx_module_t **	mod
	)

Find a module item in the SID item dictionary.

Parameters

	id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
	sid	SID of the module item to find
[out]	mod	address of return module *mod found module

Returns: status

◆ sid_dict_free()

void sid_dict_free ( uint32 id )

Free a SID tree previously allocated with sid_dict_new.

Parameters

id	SID dict ID to remove and free

Here is the call graph for this function:

◆ sid_dict_highest()

ncx_sid_t sid_dict_highest ( void )

Get the highest SID number.

Returns: highest SID assigned

◆ sid_dict_init()

status_t sid_dict_init ( void )

Initialize the YANG SID dictionary.

Returns: status

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sid_dict_init_write()

status_t sid_dict_init_write ( void )

Initialize the YANG SID dictionary for writing a SID DICT file.

Returns: status

◆ sid_dict_new()

status_t sid_dict_new ( uint32 * id )

Allocate a new SID tree for a session.

Parameters

[out]

id

address of return SID tree ID

*id return SID tree ID

Returns: status

Here is the call graph for this function:

◆ sid_dict_remove_data()

boolean sid_dict_remove_data	(	uint32	id,
		obj_template_t *	obj
	)

Remove a data object from the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
obj	object to remove

Returns: TRUE if removed; FALSE if not

Here is the caller graph for this function:

◆ sid_dict_remove_feature()

boolean sid_dict_remove_feature	(	uint32	id,
		ncx_feature_t *	feat
	)

Remove a feature identity object from the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
feat	feature to remove

Returns: TRUE if removed; FALSE if not

Here is the caller graph for this function:

◆ sid_dict_remove_identity()

boolean sid_dict_remove_identity	(	uint32	id,
		ncx_identity_t *	ident
	)

Remove an identity object from the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
ident	identity to remove

Returns: TRUE if removed; FALSE if not

Here is the caller graph for this function:

◆ sid_dict_remove_module()

boolean sid_dict_remove_module	(	uint32	id,
		ncx_module_t *	mod
	)

Remove a module object from the SID item dict.

Parameters

id	SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
mod	module to remove

Returns: TRUE if removed; FALSE if not

◆ sid_dict_walk_module_write()

status_t sid_dict_walk_module_write	(	sid_dict_walk_cbfn_t	cbfn,
		void *	cookie
	)

Walk the SID WRITE tree to generate item entries.

Must call sid_dict_add_module_write first
No SID assignments are made in this WRITE tree

Parameters

cbfn	callback function to invoke for each item
cookie	pretcnt number of SIDs used by this module

Returns

status

error in parameters
ERR_NCX_OPERATION_FAILED if callback returns FALSE to stop walk

◆ sid_dict_write_dump()

void sid_dict_write_dump ( void )

Print the sorted dictionary contents WRITE TREE.

◆ sid_dict_xml_wr()

void sid_dict_xml_wr	(	ses_cb_t *	scb,
		xml_msg_hdr_t *	mhdr,
		obj_template_t *	obj,
		boolean	external_only,
		xmlns_id_t	parent_nsid,
		ncx_sid_t	start_sid,
		ncx_sid_t	stop_sid,
		int32	indent
	)

Print the sorted dictionary contents for the yumaworks-yang-cbor get-yang-sid-info RPC operation.

Parameters

scb	session control block
mhdr	message header in progress
obj	object template for the sid-item list
external_only	TRUE for external; FALSE for all
parent_nsid	parent node namespace ID
start_sid	starting number or zero to ignore
stop_sid	stopping number or zero to ignore
indent	starting indent amount

Functions

Detailed Description

Function Documentation

◆ sid_dict_add_data()

◆ sid_dict_add_feature()

◆ sid_dict_add_identity()

◆ sid_dict_add_module()

◆ sid_dict_add_module_write()

◆ sid_dict_cleanup()

◆ sid_dict_cleanup_write()

◆ sid_dict_count()

◆ sid_dict_dump()

◆ sid_dict_find_data()

◆ sid_dict_find_feature()

◆ sid_dict_find_identity()

◆ sid_dict_find_module()

◆ sid_dict_free()

◆ sid_dict_highest()

◆ sid_dict_init()

◆ sid_dict_init_write()

◆ sid_dict_new()

◆ sid_dict_remove_data()

◆ sid_dict_remove_feature()

◆ sid_dict_remove_identity()

◆ sid_dict_remove_module()

◆ sid_dict_walk_module_write()

◆ sid_dict_write_dump()

◆ sid_dict_xml_wr()