yumapro
23.10T-12
YumaPro SDK
|
Static module defined variables maintained in ncx.c There are access APIs for each parameter. More...
Functions | |
ncx_display_mode_t | ncx_get_display_mode (void) |
Get the current default display mode. More... | |
uint32 | ncx_get_vtimeout_value (void) |
Get the virtual node cache timeout value. More... | |
boolean | ncx_get_useprefix (void) |
Get the use_prefix value. More... | |
void | ncx_set_useprefix (boolean val) |
Set the use_prefix value. More... | |
boolean | ncx_get_system_sorted (void) |
Get the system_sorted value. More... | |
void | ncx_set_system_sorted (boolean val) |
Set the system_sorted value. More... | |
ncx_sort_type_t | ncx_get_system_sort_type (void) |
Get the system_sort_type value. More... | |
void | ncx_set_system_sort_type (ncx_sort_type_t val) |
Set the system_sort_type value. More... | |
boolean | ncx_get_cwd_subdirs (void) |
Get the CLI parameter value whether to search for modules in subdirs of the CWD by default. More... | |
boolean | ncx_protocol_enabled (ncx_protocol_t proto) |
Check if the specified protocol version is enabled. More... | |
void | ncx_set_protocol_enabled (ncx_protocol_t proto) |
Set the specified protocol version to be enabled. More... | |
void | ncx_set_protocol_disabled (ncx_protocol_t proto) |
Set the specified protocol version to be disabled. More... | |
void | ncx_set_use_deadmodQ (void) |
Set the usedeadmodQ flag. More... | |
int8 | ncx_get_message_indent (void) |
Get the protoco9l output indent amount. More... | |
void | ncx_set_message_indent (int8 msg_indent) |
Set the protocol output message indent amount. More... | |
boolean | ncx_use_xpath_backptrs (void) |
Check if it is OK to use XPath back pointers or not. More... | |
status_t | ncx_set_all_obj_xpath_backptrs (void) |
Add Xpath back pointers to the data-db objects in the database. More... | |
boolean | ncx_fastpath_enabled (void) |
Check if fast path value tree comparisons enabled. More... | |
boolean | ncx_netconfd_running (void) |
Check if netconfd running. More... | |
void | ncx_use_data_templates (boolean enabled) |
Set the use-data-templates flag. More... | |
boolean | ncx_data_templates_ok (void) |
Get the use-data-templates flag. More... | |
void | ncx_ignore_missing_vars (boolean enabled) |
Set the ignore-missing-vars flag. More... | |
boolean | ncx_missing_vars_ok (void) |
Get the ignore-missing-vars flag. More... | |
void | ncx_set_ycontrol_running (void) |
Set the ycontrol_running flag to TRUE. | |
void | ncx_set_search_modQ_ok (void) |
Set the search_modQ_ok flag to TRUE. | |
boolean | ncx_get_search_modQ_ok (void) |
Get the search_modQ_ok flag. More... | |
status_t | ncx_set_subsys_id (const xmlChar *id) |
Set the subsys_id parameter for this subsystem. More... | |
const xmlChar * | ncx_get_subsys_id (void) |
Get the subsys_id value; NULL if not set. More... | |
void | ncx_set_use_objptrs (void) |
Set the use_objptrs flag. More... | |
boolean | ncx_use_objptrs (void) |
Get the use_objptrs flag. More... | |
ncx_backptr_t * | ncx_first_objptr (void) |
Get the first object pointer. More... | |
ncx_backptr_t * | ncx_next_objptr (ncx_backptr_t *curptr) |
Get the next object pointer. More... | |
void | ncx_set_getbulk_max (uint32 max_entries) |
Set the max_entries parameter for GET2 callbacks. More... | |
uint32 | ncx_get_getbulk_max (void) |
Get the max_entries parameter for GET2 callbacks. More... | |
void | ncx_set_sil_priority_used (void) |
Flag that an object set a non-default SIL priority. More... | |
boolean | ncx_get_sil_priority_used (void) |
Get the sil_priority_used flag. More... | |
void | ncx_set_secondary_sil_priority_used (void) |
Flag that a value node set a non-default secondary SIL priority. More... | |
boolean | ncx_get_secondary_sil_priority_used (void) |
Get the secondary_sil_priority_used flag. More... | |
boolean | ncx_base_schema_set (void) |
Check if the base schema features have been set yet. More... | |
void | ncx_set_base_schema (void) |
Set the base_schema_set flag to true. More... | |
boolean | ncx_need_get2_xpath (void) |
Check if GET2 callback support needed in XPath. More... | |
void | ncx_set_with_ocpattern (boolean mode) |
Set the openconfig pattern mode for the entire system. More... | |
boolean | ncx_is_add_toplevel_default_mode (void) |
Get the add_toplevel_default_mode value. More... | |
void | ncx_set_add_toplevel_default_mode (boolean val) |
Set the add_toplevel_default_mode value. More... | |
boolean | ncx_is_with_snmp (void) |
Get the with_snmp value. More... | |
void | ncx_set_with_snmp (boolean val) |
Set the with_snmp value. More... | |
void | ncx_enable_bestmatch (void) |
Enable the bestmatch import processing feature. More... | |
status_t | ncx_set_bestmatch (void) |
Setup the bestmatch module versions, if enabled. More... | |
void | ncx_allow_get_when_check (void) |
Allow server get retrievals to test for false when-stmt during retrieval operations on YANG data. | |
boolean | ncx_use_get_when_check (void) |
Check server get retrievals to test for false when-stmt during retrieval operations on YANG data. More... | |
boolean | ncx_get_sethook_registered (void) |
Check if the Set-Hook callbacks were registered. More... | |
void | ncx_set_sethook_registered (boolean val) |
Set the sethook_registered value. More... | |
void | ncx_set_binary_display_maxlen (uint32 val) |
Set the binary_display_maxlen parameter. More... | |
uint32 | ncx_get_binary_display_maxlen (void) |
Get the binary_display_maxlen parameter. More... | |
boolean | ncx_is_with_dblock (void) |
Get the is_with_dblock value. More... | |
void | ncx_set_with_dblock (boolean val) |
Set the is_with_dblock value. More... | |
boolean | ncx_is_db_lock_init_done (void) |
Check if the <db-lock-init> message was processed by the server. More... | |
void | ncx_set_db_lock_init_done (boolean val) |
Set if the <db-lock-init> message was processed by the server. More... | |
void | ncx_set_max_strlen (int32 num) |
Set the –max-strlen parameter. More... | |
int32 | ncx_get_max_strlen (void) |
Get the –max-strlen parameter. More... | |
void | ncx_set_ypwatcher_running (void) |
Set the ypwatcher running flag. More... | |
boolean | ncx_get_ypwatcher_running (void) |
Get the ypwatcher running flag. More... | |
void | ncx_set_pidfile_cleaned (void) |
Set the pidfile cleaned flag. More... | |
boolean | ncx_get_pidfile_cleaned (void) |
Get the PID file cleaned flag. More... | |
void | ncx_set_trim_whitespace (boolean val) |
Set the trim_whitespace flag. More... | |
boolean | ncx_get_trim_whitespace (void) |
Get the trim_whitespace flag. More... | |
void | ncx_set_startup_prune (boolean val) |
Set the startup_prune flag. More... | |
boolean | ncx_get_startup_prune (void) |
Get the startup_prune flag. More... | |
boolean | ncx_check_startup_prune (ses_cb_t *scb) |
Check if the namespace error can be skipped. More... | |
void | ncx_set_config_state (ncx_config_state_t val) |
Set the config_state flag. More... | |
ncx_config_state_t | ncx_get_config_state (void) |
Get the config_state flag. More... | |
void | ncx_set_xmlorder (boolean val) |
Set the xmlorder flag. More... | |
boolean | ncx_get_xmlorder (void) |
Get the xmlorder flag. More... | |
void | ncx_set_list_deleteall_ok (boolean val) |
Set the list_deleteall_ok flag. More... | |
boolean | ncx_get_list_deleteall_ok (void) |
Get the list_deleteall_ok flag. More... | |
void | ncx_set_leaflist_deleteall_ok (boolean val) |
Set the leaflist_deleteall_ok flag. More... | |
boolean | ncx_get_leaflist_deleteall_ok (void) |
Get the leaflist_deleteall_ok flag. More... | |
boolean | ncx_check_delete_all_allowed (obj_template_t *testobj) |
Check if the delete-all or remove-all operation is enabled for for specified object. More... | |
void | ncx_set_with_canonical (boolean val) |
Set the with_canonical flag. More... | |
boolean | ncx_get_with_canonical (void) |
Get the with_canonical flag. More... | |
void | ncx_set_save_owners (boolean val) |
Set the save_owners flag. More... | |
boolean | ncx_get_save_owners (void) |
Get the save_owners flag. More... | |
Static module defined variables maintained in ncx.c There are access APIs for each parameter.
Often some server and yangcli-pro parameters need to be configured so YANG and XPath functions in the NCX library can operate correctly.
boolean ncx_base_schema_set | ( | void | ) |
Check if the base schema features have been set yet.
Used by YANG compiler only
boolean ncx_check_delete_all_allowed | ( | obj_template_t * | testobj | ) |
Check if the delete-all or remove-all operation is enabled for for specified object.
testobj | object to check |
boolean ncx_check_startup_prune | ( | ses_cb_t * | scb | ) |
Check if the namespace error can be skipped.
Will not generate rpc-error if this test is true
scb | session control block |
boolean ncx_data_templates_ok | ( | void | ) |
Get the use-data-templates flag.
void ncx_enable_bestmatch | ( | void | ) |
Enable the bestmatch import processing feature.
Set the allow_bestmatch flag
boolean ncx_fastpath_enabled | ( | void | ) |
Check if fast path value tree comparisons enabled.
ncx_backptr_t * ncx_first_objptr | ( | void | ) |
Get the first object pointer.
uint32 ncx_get_binary_display_maxlen | ( | void | ) |
Get the binary_display_maxlen parameter.
ncx_config_state_t ncx_get_config_state | ( | void | ) |
Get the config_state flag.
boolean ncx_get_cwd_subdirs | ( | void | ) |
Get the CLI parameter value whether to search for modules in subdirs of the CWD by default.
Does not affect YUMA_MODPATH or other hard-wired searches
ncx_display_mode_t ncx_get_display_mode | ( | void | ) |
Get the current default display mode.
uint32 ncx_get_getbulk_max | ( | void | ) |
Get the max_entries parameter for GET2 callbacks.
boolean ncx_get_leaflist_deleteall_ok | ( | void | ) |
Get the leaflist_deleteall_ok flag.
boolean ncx_get_list_deleteall_ok | ( | void | ) |
Get the list_deleteall_ok flag.
int32 ncx_get_max_strlen | ( | void | ) |
Get the –max-strlen parameter.
int8 ncx_get_message_indent | ( | void | ) |
Get the protoco9l output indent amount.
This is the indent level for text-based protocol messages. It is usually set to -1 for production use and 1 for debugging.
boolean ncx_get_pidfile_cleaned | ( | void | ) |
Get the PID file cleaned flag.
boolean ncx_get_save_owners | ( | void | ) |
Get the save_owners flag.
boolean ncx_get_search_modQ_ok | ( | void | ) |
Get the search_modQ_ok flag.
boolean ncx_get_secondary_sil_priority_used | ( | void | ) |
Get the secondary_sil_priority_used flag.
boolean ncx_get_sethook_registered | ( | void | ) |
Check if the Set-Hook callbacks were registered.
boolean ncx_get_sil_priority_used | ( | void | ) |
Get the sil_priority_used flag.
boolean ncx_get_startup_prune | ( | void | ) |
Get the startup_prune flag.
Server –startup-prune-ok CLI parm
const xmlChar * ncx_get_subsys_id | ( | void | ) |
Get the subsys_id value; NULL if not set.
ncx_sort_type_t ncx_get_system_sort_type | ( | void | ) |
Get the system_sort_type value.
Always NCX_SORT_OFF if system-sorted=false
boolean ncx_get_system_sorted | ( | void | ) |
Get the system_sorted value.
boolean ncx_get_trim_whitespace | ( | void | ) |
Get the trim_whitespace flag.
boolean ncx_get_useprefix | ( | void | ) |
Get the use_prefix value.
uint32 ncx_get_vtimeout_value | ( | void | ) |
Get the virtual node cache timeout value.
boolean ncx_get_with_canonical | ( | void | ) |
Get the with_canonical flag.
boolean ncx_get_xmlorder | ( | void | ) |
Get the xmlorder flag.
boolean ncx_get_ypwatcher_running | ( | void | ) |
Get the ypwatcher running flag.
void ncx_ignore_missing_vars | ( | boolean | enabled | ) |
Set the ignore-missing-vars flag.
enabled | TRUE if OK to ignore missing vars, FALSE if not |
boolean ncx_is_add_toplevel_default_mode | ( | void | ) |
Get the add_toplevel_default_mode value.
boolean ncx_is_db_lock_init_done | ( | void | ) |
Check if the <db-lock-init> message was processed by the server.
boolean ncx_is_with_dblock | ( | void | ) |
Get the is_with_dblock value.
boolean ncx_is_with_snmp | ( | void | ) |
Get the with_snmp value.
Used by the server only
boolean ncx_missing_vars_ok | ( | void | ) |
Get the ignore-missing-vars flag.
boolean ncx_need_get2_xpath | ( | void | ) |
Check if GET2 callback support needed in XPath.
Only the server uses this feature at this time
boolean ncx_netconfd_running | ( | void | ) |
Check if netconfd running.
ncx_backptr_t * ncx_next_objptr | ( | ncx_backptr_t * | curptr | ) |
Get the next object pointer.
curptr | curent object pointer |
boolean ncx_protocol_enabled | ( | ncx_protocol_t | proto | ) |
Check if the specified protocol version is enabled.
void ncx_set_add_toplevel_default_mode | ( | boolean | val | ) |
Set the add_toplevel_default_mode value.
val | TRUE if adding Top level defaults during the agt_init phase |
status_t ncx_set_all_obj_xpath_backptrs | ( | void | ) |
Add Xpath back pointers to the data-db objects in the database.
void ncx_set_base_schema | ( | void | ) |
Set the base_schema_set flag to true.
Used by YANG compiler only
status_t ncx_set_bestmatch | ( | void | ) |
Setup the bestmatch module versions, if enabled.
This is an action and will cause the module search path to be examined for all revisions of all modules found
void ncx_set_binary_display_maxlen | ( | uint32 | val | ) |
Set the binary_display_maxlen parameter.
val | number to set as max binary display length |
void ncx_set_config_state | ( | ncx_config_state_t | val | ) |
Set the config_state flag.
Controls if the datastores can be accessed
val | config state enum value to set |
void ncx_set_db_lock_init_done | ( | boolean | val | ) |
Set if the <db-lock-init> message was processed by the server.
val | TRUE if <db-lock-init> was already processed by the server |
void ncx_set_getbulk_max | ( | uint32 | max_entries | ) |
Set the max_entries parameter for GET2 callbacks.
0 == no max, but for internal purposes, limit to 512
max_entries | max number of getbulk entries to allow |
void ncx_set_leaflist_deleteall_ok | ( | boolean | val | ) |
Set the leaflist_deleteall_ok flag.
val | TRUE to allow the YumaWorks nc:operation=delete-all value for YANG leaf-lists |
void ncx_set_list_deleteall_ok | ( | boolean | val | ) |
Set the list_deleteall_ok flag.
val | TRUE to allow the YumaWorks nc:operation=delete-all value for YANG lists |
void ncx_set_max_strlen | ( | int32 | num | ) |
Set the –max-strlen parameter.
num | max-strlen number to use; if out of range it will be changed |
void ncx_set_message_indent | ( | int8 | msg_indent | ) |
Set the protocol output message indent amount.
msg_indent | -1 .. 9 : message-indent parameter value |
void ncx_set_pidfile_cleaned | ( | void | ) |
Set the pidfile cleaned flag.
void ncx_set_protocol_disabled | ( | ncx_protocol_t | proto | ) |
Set the specified protocol version to be disabled.
proto | protocol version to enable |
void ncx_set_protocol_enabled | ( | ncx_protocol_t | proto | ) |
Set the specified protocol version to be enabled.
proto | protocol version to enable |
void ncx_set_save_owners | ( | boolean | val | ) |
Set the save_owners flag.
This will cause owner IDs to be maintained for the configuration data in the server
val | TRUE if YANG Configuration owner IDs should be saved |
void ncx_set_secondary_sil_priority_used | ( | void | ) |
Flag that a value node set a non-default secondary SIL priority.
Set secondary_sil_priority_used to TRUE, meaning that secondary SIL priority was set to non-default value. Can be set only by Set Order Hook callback. the direct call to val_set_sil_priority() will not affect this flag, and will not affect the secondary SIL priority
void ncx_set_sethook_registered | ( | boolean | val | ) |
Set the sethook_registered value.
val | TRUE if there are Set-Hook callbacks; FALSE if there is NO |
void ncx_set_sil_priority_used | ( | void | ) |
Flag that an object set a non-default SIL priority.
Used by server only to optimize SIL callback processing
void ncx_set_startup_prune | ( | boolean | val | ) |
Set the startup_prune flag.
Server –startup-prune-ok CLI parm
val | TRUE if OK to prune unknown data from the startup config; FALSE to stop parsing with an error |
status_t ncx_set_subsys_id | ( | const xmlChar * | id | ) |
Set the subsys_id parameter for this subsystem.
id | subsys-id to use |
void ncx_set_system_sort_type | ( | ncx_sort_type_t | val | ) |
Set the system_sort_type value.
val | ncx_sort_type_t enumberation value |
void ncx_set_system_sorted | ( | boolean | val | ) |
Set the system_sorted value.
val | TRUE if system ordered objects should be sorted; FALSE if system ordered objects should not be sorted |
void ncx_set_trim_whitespace | ( | boolean | val | ) |
Set the trim_whitespace flag.
Setting this to true
will violate the XML standard that says all chanracters in an XML string node are significant
val | TRUE to trim whitespace; FALSE to not trim whitespace |
void ncx_set_use_deadmodQ | ( | void | ) |
Set the usedeadmodQ flag.
This is needed by the server and other tools to prevent corner-cases where deviations still point at the removed module. Prevents corrupted memory in case the deviation is accessed
void ncx_set_use_objptrs | ( | void | ) |
Set the use_objptrs flag.
void ncx_set_useprefix | ( | boolean | val | ) |
Set the use_prefix value.
val | TRUE if XML prefixes should be used; FALSE if XML messages should use default namespace (no prefix) |
void ncx_set_with_canonical | ( | boolean | val | ) |
Set the with_canonical flag.
val | TRUE if YANG canonical automation should be enabled |
void ncx_set_with_dblock | ( | boolean | val | ) |
Set the is_with_dblock value.
val | TRUE if with-db-lock=true |
void ncx_set_with_ocpattern | ( | boolean | mode | ) |
Set the openconfig pattern mode for the entire system.
mode | T: for openconfig mode [POSIX] F: IETF mode [XSD] This should get set before any openconfig modules are loaded |
void ncx_set_with_snmp | ( | boolean | val | ) |
Set the with_snmp value.
Used by the server only
val | TRUE if with-snmp=true |
void ncx_set_xmlorder | ( | boolean | val | ) |
Set the xmlorder flag.
Server –use-xmlorder CLI paramter
val | TRUE to enforce strict XML order; FAALSE to allow misordered XML |
void ncx_set_ypwatcher_running | ( | void | ) |
Set the ypwatcher running flag.
void ncx_use_data_templates | ( | boolean | enabled | ) |
Set the use-data-templates flag.
enabled | TRUE if enabled, FALSE if not |
boolean ncx_use_get_when_check | ( | void | ) |
Check server get retrievals to test for false when-stmt during retrieval operations on YANG data.
boolean ncx_use_objptrs | ( | void | ) |
Get the use_objptrs flag.
These are used to hold the queue of top-level data nodes
boolean ncx_use_xpath_backptrs | ( | void | ) |
Check if it is OK to use XPath back pointers or not.