yumapro  23.10T-5
YumaPro SDK
Loading...
Searching...
No Matches
YANG SID Dictionary

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...
 
void sid_dict_cleanup (void)
 Cleanup the YANG SID dictionary. 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...
 
bool 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...
 
bool 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...
 
bool 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...
 
bool 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...
 
void sid_dict_dump (uint32 id)
 Print the sorted dictionary contents. 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
objobject to add
internalTRUE 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
featfeature to add
internalTRUE 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
identidentity to add
internalTRUE 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
modmodule to add
internalTRUE if internal item; FALSE if visible to all
Returns
status
Here is the caller 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_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
idSID 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
sidSID of the data item to find
[out]objaddress 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
sidSID of the feature item to find
[out]feataddress 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
sidSID of the identity item to find
[out]identaddress 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
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
sidSID of the module item to find
[out]modaddress 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
idSID 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_new()

status_t sid_dict_new ( uint32 *  id)

Allocate a new SID tree for a session.

Parameters
[out]idaddress of return SID tree ID
  • *id return SID tree ID
Returns
status
Here is the call graph for this function:

◆ sid_dict_remove_data()

bool sid_dict_remove_data ( uint32  id,
obj_template_t obj 
)

Remove a data object from the SID item dict.

Parameters
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
objobject to remove
Returns
TRUE if removed; FALSE if not
Here is the caller graph for this function:

◆ sid_dict_remove_feature()

bool sid_dict_remove_feature ( uint32  id,
ncx_feature_t feat 
)

Remove a feature identity object from the SID item dict.

Parameters
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
featfeature to remove
Returns
TRUE if removed; FALSE if not
Here is the caller graph for this function:

◆ sid_dict_remove_identity()

bool sid_dict_remove_identity ( uint32  id,
ncx_identity_t ident 
)

Remove an identity object from the SID item dict.

Parameters
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
identidentity to remove
Returns
TRUE if removed; FALSE if not
Here is the caller graph for this function:

◆ sid_dict_remove_module()

bool sid_dict_remove_module ( uint32  id,
ncx_module_t mod 
)

Remove a module object from the SID item dict.

Parameters
idSID dict ID (SID_DICT_SERVER or assigned from sid_dict_new)
modmodule to remove
Returns
TRUE if removed; FALSE if not

◆ 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
scbsession control block
mhdrmessage header in progress
objobject template for the sid-item list
external_onlyTRUE for external; FALSE for all
parent_nsidparent node namespace ID
start_sidstarting number or zero to ignore
stop_sidstopping number or zero to ignore
indentstarting indent amount