yumapro
24.10-2
YumaPro SDK
|
Schema Item Identifier assignment mapping dictionary. More...
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... | |
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.
status_t sid_dict_add_data | ( | uint32 | id, |
obj_template_t * | obj, | ||
boolean | internal | ||
) |
Store a data item in the SID item dict.
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 |
status_t sid_dict_add_feature | ( | uint32 | id, |
ncx_feature_t * | feat, | ||
boolean | internal | ||
) |
Store a feature item in the SID item dict.
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 |
status_t sid_dict_add_identity | ( | uint32 | id, |
ncx_identity_t * | ident, | ||
boolean | internal | ||
) |
Store an identity item in the SID item dict.
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 |
status_t sid_dict_add_module | ( | uint32 | id, |
ncx_module_t * | mod, | ||
boolean | internal | ||
) |
Store a module item in the SID item dict.
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 |
void sid_dict_cleanup | ( | void | ) |
Cleanup the YANG SID dictionary.
uint32 sid_dict_count | ( | void | ) |
Get the current count of SID numbers.
void sid_dict_dump | ( | uint32 | id | ) |
Print the sorted dictionary contents.
id | SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new) |
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.
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
|
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.
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
|
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.
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
|
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.
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
|
void sid_dict_free | ( | uint32 | id | ) |
Free a SID tree previously allocated with sid_dict_new.
id | SID dict ID to remove and free |
ncx_sid_t sid_dict_highest | ( | void | ) |
Get the highest SID number.
status_t sid_dict_init | ( | void | ) |
Initialize the YANG SID dictionary.
status_t sid_dict_new | ( | uint32 * | id | ) |
Allocate a new SID tree for a session.
[out] | id | address of return SID tree ID
|
bool sid_dict_remove_data | ( | uint32 | id, |
obj_template_t * | obj | ||
) |
Remove a data object from the SID item dict.
id | SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new) |
obj | object to remove |
bool sid_dict_remove_feature | ( | uint32 | id, |
ncx_feature_t * | feat | ||
) |
Remove a feature identity object from the SID item dict.
id | SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new) |
feat | feature to remove |
bool sid_dict_remove_identity | ( | uint32 | id, |
ncx_identity_t * | ident | ||
) |
Remove an identity object from the SID item dict.
id | SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new) |
ident | identity to remove |
bool sid_dict_remove_module | ( | uint32 | id, |
ncx_module_t * | mod | ||
) |
Remove a module object from the SID item dict.
id | SID dict ID (SID_DICT_SERVER or assigned from sid_dict_new) |
mod | module to remove |
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.
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 |