yumapro  25.10-3
YumaPro SDK
Loading...
Searching...
No Matches
ncx.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
3 * Copyright (c) 2012 - 2025, YumaWorks, Inc., All Rights Reserved.
4 *
5 * Unless required by applicable law or agreed to in writing,
6 * software distributed under the License is distributed on an
7 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8 * KIND, either express or implied. See the License for the
9 * specific language governing permissions and limitations
10 * under the License.
11 */
12#ifndef _H_ncx
13#define _H_ncx
14
15/*
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
32/********************************************************************
33* *
34* C H A N G E H I S T O R Y *
35* *
36*********************************************************************
37
38date init comment
39----------------------------------------------------------------------
4029-oct-05 abb Begun
4120-jul-08 abb Start YANG rewrite; remove PSD and PS
4223-aug-09 abb Update diagram in header
43*/
44
45#include <xmlstring.h>
46
47#ifndef _H_dlq
48#include "dlq.h"
49#endif
50
51#ifndef _H_getcb
52#include "getcb.h"
53#endif
54
55#ifndef _H_grp
56#include "grp.h"
57#endif
58
59#ifndef _H_log
60#include "log.h"
61#endif
62
63#ifndef _H_ncxconst
64#include "ncxconst.h"
65#endif
66
67#ifndef _H_ncxtypes
68#include "ncxtypes.h"
69#endif
70
71#ifndef _H_obj
72#include "obj.h"
73#endif
74
75#ifndef _H_rpc
76#include "rpc.h"
77#endif
78
79#ifndef _H_tk
80#include "tk.h"
81#endif
82
83#ifndef _H_typ
84#include "typ.h"
85#endif
86
87#ifndef _H_val
88#include "val.h"
89#endif
90
91#ifndef _H_xmlns
92#include "xmlns.h"
93#endif
94
95#ifndef _H_yang
96#include "yang.h"
97#endif
98
99#ifdef __cplusplus
100extern "C" {
101#endif
102
103/* macro to convert 'foo' in -DRELEASE=foo to a string */
104#define STRINGIFY0(v) #v
105#define STRINGIFY(v) STRINGIFY0(v)
106
108#define MOD_NAME(M) (M)->name
109
110
111#define PROGNAME_BUFFLEN 128
112
113/********************************************************************
114* *
115* F U N C T I O N S *
116* *
117*********************************************************************/
118
156/* access the rootcb 'active' flag; set differently
157 * on server than on the client
158 */
159#define ROOTCB_ACTIVE(R) (R)->active
160
161/* access label in rootcb */
162#define ROOTCB_LABEL(R) (R)->label
163
164/* access modname in rootcb */
165#define ROOTCB_MODNAME(R) (R)->modname
166
167/* access yanglib_cb field in rootcb */
168#define ROOTCB_YANGLIB_CB(R) &((R)->yanglib_cb)
169
170/* access objpath field */
171#define ROOTCB_OBJPATH(R) (R)->objpath
172
173/* access rootobj field */
174#define ROOTCB_ROOTOBJ(R) (R)->rootobj
175
176/* access module queue */
177#define ROOTCB_MODQ(R) &((R)->modQ)
178
179/* access deviation queue */
180#define ROOTCB_DEVQ(R) &((R)->devQ)
181
183#define ROOTCB_CAPLIST(R) (R)->caplist
184
220extern status_t
221 ncx_init (boolean netconfd,
222 boolean savestr,
223 log_debug_t dlevel,
224 boolean logtstamps,
225 boolean collapse_submods,
226 boolean xpath_backptrs,
227 const char *startmsg,
228 int argc,
229 char *argv[]);
230
231
237extern void
238 ncx_cleanup (void);
239 // END ncxlib/ncxinit
241
242
243
244
245// Header only for NCX Global Data Docs
246
256// Header only for Protocol Support Docs
257
267// Header only for NCX Global Data Docs
268
278// Header only for YANG Compiler Docs
279
289// heading only for YANG Library Docs
290
301// Heading only for YANG Module Docs
302 // BEGIN ncxlib/yang/yangcomp/yangcompgen
322
323
330extern ncx_module_t *
331 ncx_new_module (void);
332
333
350extern void
352
353
363extern status_t
365 boolean tempmod);
366
367
377extern status_t
379
380
392extern status_t
394 dlq_hdr_t *modQ);
395
396
407extern status_t
409
410
420extern status_t
422
423
436extern void
438 const xmlChar *modname,
439 const xmlChar *rpcname,
440 boolean match,
441 boolean firstmsg);
442
443
453extern const xmlChar *
454 ncx_get_name_segment (const xmlChar *str,
455 xmlChar *buff,
456 uint32 buffsize);
457
458
466extern status_t
468 ncx_status_t depstatus);
469
470
479extern void
480 ncx_free_node (ncx_node_t nodetyp,
481 void *node);
482
483
490extern ncx_tclass_t
492
493
505extern status_t
506 ncx_parse_name (const xmlChar *str,
507 uint32 *len);
508
509
523extern status_t
525 ncx_module_t *mod,
526 const xmlChar *name,
527 ncx_opt_t opt);
528
529
550extern status_t
552 ncx_module_t *mod,
553 const xmlChar *name,
554 xmlChar **namebuff,
555 ncx_opt_t opt,
556 tk_type_t ctyp);
557
558
573extern status_t
575 ncx_module_t *mod,
576 tk_type_t ttyp);
577
578
589 boolean annotation);
590
591
597extern void
599
600
606extern void
607 ncx_clean_save_deviationsQ (dlq_hdr_t *savedevQ);
608
609
622extern void
624 ncx_module_t *mod,
625 uint32 linenum,
626 uint32 linepos);
627
628
634extern void
636
637
646extern boolean
647 ncx_need_modchecks (const xmlChar *modname);
648
649
655extern status_t
656 ncx_init_user_types (void);
657
658
667extern boolean
668 ncx_check_any_object_nolock_get (const xmlChar *objname);
669
670 // END ncxlib/yang/yangcomp/yangcompgen
672
673
674 // BEGIN ncxlib/yang/yanglib/yanglibstatus
682
683
690extern boolean
691 ncx_any_mod_errors (void);
692
693
700extern boolean
701 ncx_save_descr (void);
702
703
714extern uint32
716 const xmlChar *modname);
717
718
728extern uint32
730 dlq_hdr_t *modQ,
731 const xmlChar *modname);
732
733
743extern uint32
745 dlq_hdr_t *deviationQ,
746 const xmlChar *modname);
747
748
754extern void
755 dump_modQ (dlq_hdr_t *modQ);
756
757 // END ncxlib/yang/yanglib/yanglibstatus
759
760 // BEGIN ncxlib/yang/yanglib/yanglibfind
779
780
791extern ncx_module_t *
792 ncx_find_module (const xmlChar *modname,
793 const xmlChar *revision);
794
795
807extern ncx_module_t *
808 ncx_find_module_ex (const xmlChar *modname,
809 const xmlChar *revision);
810
811
822extern ncx_module_t *
823 ncx_find_module_by_prefix (const xmlChar *prefix);
824
825
835extern ncx_module_t *
836 ncx_find_module_que (dlq_hdr_t *modQ,
837 const xmlChar *modname,
838 const xmlChar *revision);
839
840
848extern ncx_module_t *
849 ncx_find_module_que_by_prefix (dlq_hdr_t *modQ,
850 const xmlChar *prefix);
851
852
862extern ncx_module_t *
863 ncx_find_module_que_nsid (dlq_hdr_t *modQ,
864 xmlns_id_t nsid);
865
866
876extern obj_template_t *
877 ncx_find_first_rpc (const xmlChar *rpcname);
878
879
892extern obj_template_t *
893 ncx_match_any_rpc (const xmlChar *module,
894 const xmlChar *rpcname,
895 uint32 *retcount);
896
897
907extern obj_template_t *
908 ncx_find_any_object (const xmlChar *objname);
909
910
928extern obj_template_t *
929 ncx_match_any_object (const xmlChar *objname,
930 ncx_name_match_t name_match,
931 boolean alt_names,
932 status_t *retres);
933
934
955extern obj_template_t *
956 ncx_match_any_object_ex (const xmlChar *modname,
957 const xmlChar *objname,
958 boolean dataonly,
959 ncx_name_match_t name_match,
960 boolean alt_names,
961 status_t *retres);
962
963
964
975extern obj_template_t *
976 ncx_find_any_object_que (dlq_hdr_t *modQ,
977 const xmlChar *objname);
978
979
986extern ncx_module_t *
988
989
998extern ncx_module_t *
1000
1001
1008extern ncx_module_t *
1010
1011
1019extern ncx_module_t *
1020 ncx_get_next_module (const ncx_module_t *mod);
1021
1022
1032extern ncx_module_t *
1034
1035
1045extern ncx_module_t *
1047
1048
1055extern ncx_module_t *
1056 ncx_find_first_importer (const xmlChar *module);
1057
1058
1066extern ncx_module_t *
1067 ncx_find_next_importer (const xmlChar *module,
1068 ncx_module_t *curmod);
1069
1070
1077extern ncx_module_t *
1078 ncx_find_deviation_module (const xmlChar *modname);
1079
1080
1088extern obj_template_t *
1089 ncx_first_data_node (boolean cfgonly);
1090
1091
1099extern obj_template_t *
1101
1102
1108extern ncx_module_t *
1110
1111
1118extern ncx_module_t *
1120
1121 // END ncxlib/yang/yanglib/yanglibfind
1123
1124
1125
1144extern obj_template_t *
1146 const xmlChar *rpcname,
1147 uint32 *retcount);
1148
1149
1164extern typ_template_t *
1166 const xmlChar *typname,
1167 boolean useall);
1168
1169
1186extern typ_template_t *
1188 const xmlChar *name,
1189 boolean useall);
1190
1191
1203extern typ_template_t *
1204 ncx_find_type_que (const dlq_hdr_t *typeQ,
1205 const xmlChar *typname);
1206
1207
1223extern grp_template_t *
1225 const xmlChar *grpname,
1226 boolean useall);
1227
1228
1237extern grp_template_t *
1238 ncx_find_grouping_que (const dlq_hdr_t *groupingQ,
1239 const xmlChar *grpname);
1240
1241
1249extern obj_template_t *
1250 ncx_find_rpc (const ncx_module_t *mod,
1251 const xmlChar *rpcname);
1252
1253
1263extern obj_template_t *
1265 const xmlChar *rpcname,
1266 uint32 *retcount);
1267
1268
1279extern obj_template_t *
1281
1282
1292extern obj_template_t *
1294 obj_template_t *obj);
1295
1296
1304extern obj_template_t *
1306 const xmlChar *objname);
1307
1315extern obj_template_t *
1317 const xmlChar *objname);
1318
1319
1329extern obj_template_t *
1331
1332
1342extern obj_template_t *
1344 boolean augment_ok);
1345
1346
1358extern obj_template_t *
1360 boolean augment_ok);
1361
1362
1373extern obj_template_t *
1375 obj_template_t *curobj);
1376
1377
1391extern obj_template_t *
1393 obj_template_t *curobj,
1394 boolean augment_ok);
1395
1396
1409extern obj_template_t *
1411 obj_template_t *curobj,
1412 boolean augment_ok);
1413
1414
1422extern obj_template_t *
1424 obj_template_t *curobj);
1425
1426
1435extern obj_template_t *
1437 boolean config);
1438
1439
1449extern obj_template_t *
1451 obj_template_t *curobj);
1452
1453 // END ncxlib/yang/yangmod/yangmodfind
1455
1456 // BEGIN ncxlib/yang/yangmod/yangmodprop
1464
1465
1473extern boolean
1475
1476
1487extern boolean
1489 const xmlChar *defname);
1490
1491
1498extern const xmlChar *
1499 ncx_get_modname (const ncx_module_t *mod);
1500
1501
1508extern xmlns_id_t
1509 ncx_get_mod_nsid (const ncx_module_t *mod);
1510
1511
1518extern const xmlChar *
1519 ncx_get_modversion (const ncx_module_t *mod);
1520
1521
1528extern const xmlChar *
1530
1531
1538extern const xmlChar *
1539 ncx_get_modsource (const ncx_module_t *mod);
1540
1541
1548extern ncx_module_t *
1550
1551
1552
1559extern const xmlChar *
1560 ncx_get_mod_prefix (const ncx_module_t *mod);
1561
1562
1574extern const xmlChar *
1576
1577
1584extern const xmlChar *
1585 ncx_get_mod_source (const ncx_module_t *mod);
1586
1587
1594extern const xmlChar *
1596
1597
1604extern const xmlChar *
1606
1607
1617extern status_t
1619 const xmlChar *ocversion);
1620
1621
1628extern const xmlChar *
1630
1631
1641extern status_t
1643 const xmlChar *version);
1644
1645
1660extern status_t
1661 ncx_compare_semvers (const xmlChar *version1,
1662 const xmlChar *version2,
1663 int32 *ret);
1664
1665
1673extern dlq_hdr_t *
1675
1676
1684extern const dlq_hdr_t *
1686
1687
1695extern ncx_module_t *
1697
1698
1705extern boolean
1707
1708
1717extern boolean
1719 boolean check_config,
1720 boolean check_operational);
1721
1722
1732extern boolean
1734 boolean check_config,
1735 boolean check_operational);
1736
1737
1746extern boolean
1748
1749
1756extern void
1758
1759
1766extern ncx_module_t *
1768
1769
1770
1778extern ncx_module_t *
1780 ncx_module_t *submod);
1781
1782
1789extern void
1791 boolean supported);
1792
1793
1800extern ncx_yang_version_t
1802
1803
1809extern void
1811
1812
1824extern boolean
1825 ncx_mod_is_hidden (const ncx_module_t *mod);
1826
1827
1837extern void
1838 ncx_set_mod_hidden (ncx_module_t *mod);
1839
1840
1848extern status_t
1850 const xmlChar *idstr);
1851
1852
1859extern void
1861 boolean mode);
1862
1863
1869extern void
1871
1872
1879extern boolean
1881
1882
1889extern boolean
1890 ncx_modname_is_ocpattern (const xmlChar *modname);
1891
1892
1903extern boolean
1904 ncx_skip_child_node_warn (const xmlChar *modname);
1905
1906
1913extern void ncx_clr_enable_chk (ncx_module_t *mod);
1914
1915
1922extern void
1924 boolean is_src);
1925
1926
1934extern boolean
1936 boolean is_src);
1937
1938
1947extern boolean
1949
1950 // END ncxlib/yang/yangmod/yangmodprop
1952
1953
1954 // BEGIN ncxlib/yang/yangmod/yangmodutil
1962
1963
1973extern void
1975
1976
1987extern void
1989
1990
2007extern void
2009
2010
2011
2021extern status_t
2023
2024
2031extern void
2033
2034
2041extern void
2043
2044
2051extern void
2053
2054 // END ncxlib/yang/yangmod/yangmodutil
2056
2057
2058
2059
2060// Heading only for YANG Data Docs
2061
2062
2088extern ncx_import_t *
2089 ncx_new_import (void);
2090
2091
2102extern void
2103 ncx_free_import (ncx_import_t *import);
2104
2105
2113extern ncx_import_t *
2114 ncx_find_import (const ncx_module_t *mod,
2115 const xmlChar *module);
2116
2117
2125extern ncx_import_t *
2126 ncx_find_import_que (const dlq_hdr_t *importQ,
2127 const xmlChar *module);
2128
2129
2139extern ncx_import_t *
2141 const xmlChar *module);
2142
2143
2151extern ncx_import_t *
2153 const xmlChar *prefix);
2154
2155
2163extern ncx_import_t *
2164 ncx_find_pre_import_que (const dlq_hdr_t *importQ,
2165 const xmlChar *prefix);
2166
2167
2177extern ncx_import_t *
2179 const xmlChar *prefix);
2180
2181
2190extern boolean
2192 const xmlChar *module,
2193 const xmlChar *revision);
2194
2195
2215extern void *
2217 ncx_import_t *imp,
2218 const xmlChar *defname,
2219 ncx_node_t *deftyp);
2220 // END ncxlib/yang/yangdata/yangimport
2222
2223
2224
2240extern ncx_include_t *
2241 ncx_new_include (void);
2242
2243
2254extern void
2256
2257
2265extern ncx_include_t *
2266 ncx_find_include (const ncx_module_t *mod,
2267 const xmlChar *submodule);
2268
2269 // END ncxlib/yang/yangdata/yanginclude
2271
2272
2294extern ncx_binary_t *
2295 ncx_new_binary (void);
2296
2297
2302extern void
2303 ncx_init_binary (ncx_binary_t *binary);
2304
2305
2311extern void
2313
2314
2320extern void
2321 ncx_free_binary (ncx_binary_t *binary);
2322
2323 // END ncxlib/yang/yangdata/yangbindata
2325
2326 // BEGIN ncxlib/yang/yangdata/yangidentity
2334
2335
2341extern ncx_identity_t *
2342 ncx_new_identity (void);
2343
2344
2351extern ncx_identity_base_t *
2352 ncx_new_identity_base (void);
2353
2354
2360extern void
2362
2363
2370extern ncx_identity_base_t *
2372
2373
2380extern ncx_identity_base_t *
2382
2383
2390extern uint32
2391 ncx_identity_base_count (ncx_identity_t *identity);
2392
2393
2399extern void
2401
2402
2413extern ncx_identity_t *
2415 const xmlChar *name,
2416 boolean useall);
2417
2418
2427extern void
2430 void *cookie);
2431
2432
2433/*
2434 * @brief Iterate all the YANG object definitions in the module
2435 *
2436 * @param mod module to search
2437 * @param cbfn The object_cbfn_t to invoke for each object found
2438 * @param cookie User cookie to pass to callback (may be NULL)
2439 */
2440extern void
2441 ncx_for_all_objects (ncx_module_t *mod,
2442 ncx_object_cbfn_t cbfn,
2443 void *cookie);
2444
2445
2446
2447/*
2448 * @brief Iterate all the external augments YANG object definitions
2449 * in the module
2450 *
2451 * @param mod module to search
2452 * @param cbfn The object_cbfn_t to invoke for each object found
2453 * @param cookie User cookie to pass to callback (may be NULL)
2454 */
2455extern void
2456 ncx_for_all_ext_augments (ncx_module_t *mod,
2457 ncx_object_cbfn_t cbfn,
2458 void *cookie);
2459
2460
2468extern ncx_identity_t *
2469 ncx_find_identity_que (dlq_hdr_t *identityQ,
2470 const xmlChar *name);
2471
2472
2479extern xmlns_id_t
2480 ncx_get_identity_nsid (const ncx_identity_t *identity);
2481
2482
2489extern boolean
2491
2492
2505extern void
2508 void *cookie);
2509
2510
2511 // END ncxlib/yang/yangdata/yangidentity
2513
2514
2531extern ncx_filptr_t *
2532 ncx_new_filptr (void);
2533
2534
2540extern void
2541 ncx_free_filptr (ncx_filptr_t *filptr);
2542
2543
2549extern ncx_revhist_t *
2550 ncx_new_revhist (void);
2551
2552
2557extern void
2559
2560
2568extern ncx_revhist_t *
2569 ncx_find_revhist (const ncx_module_t *mod,
2570 const xmlChar *ver);
2571
2572 // END ncxlib/yang/yangdata/yangcompgen
2574
2575
2591extern void
2593
2594
2600extern void
2602
2603
2615extern int32
2616 ncx_compare_enums (const ncx_enum_t *enu1,
2617 const ncx_enum_t *enu2);
2618
2619
2631extern status_t
2632 ncx_set_enum (const xmlChar *enum_name,
2633 const int32 enum_val,
2634 ncx_enum_t *retenu);
2635
2636 // END ncxlib/yang/yangdata/yangenum
2638
2639
2654extern void
2655 ncx_init_bit (ncx_bit_t *bit);
2656
2657
2663extern void
2664 ncx_clean_bit (ncx_bit_t *bit);
2665
2666
2679extern int32
2680 ncx_compare_bits (const ncx_bit_t *bitone,
2681 const ncx_bit_t *bittwo);
2682
2683 // END ncxlib/yang/yangdata/yangbit
2685
2686
2687
2702extern ncx_typname_t *
2703 ncx_new_typname (void);
2704
2705
2712extern void
2714
2715
2723extern const xmlChar *
2724 ncx_find_typname (const typ_template_t *typ,
2725 const dlq_hdr_t *que);
2726
2727
2736extern const typ_template_t *
2737 ncx_find_typname_type (const dlq_hdr_t *que,
2738 const xmlChar *typname);
2739
2740
2746extern void
2747 ncx_clean_typnameQ (dlq_hdr_t *que);
2748
2749 // END ncxlib/yang/yangdata/yangtypname
2751
2752
2768extern ncx_errinfo_t *
2769 ncx_new_errinfo (void);
2770
2771
2777extern void
2779
2780
2787extern void
2789
2790
2797extern void
2799
2800
2811extern boolean
2812 ncx_errinfo_set (const ncx_errinfo_t *errinfo);
2813
2814
2823extern status_t
2824 ncx_copy_errinfo (const ncx_errinfo_t *src,
2825 ncx_errinfo_t *dest);
2826
2827
2828 // END ncxlib/yang/yangdata/yangdataerrinfo
2830
2831
2832
2833
2834
2835
2836
2837 // BEGIN ncxlib/ncxglobals/ncxgenobj
2847
2848
2854extern obj_template_t *
2855 ncx_get_gen_anyxml (void);
2856
2857
2863extern obj_template_t *
2864 ncx_get_gen_container (void);
2865
2866
2872extern obj_template_t *
2873 ncx_get_gen_string (void);
2874
2875
2881extern obj_template_t *
2882 ncx_get_gen_empty (void);
2883
2884
2890extern obj_template_t *
2891 ncx_get_gen_root (void);
2892
2893
2899extern obj_template_t *
2900 ncx_get_gen_binary (void);
2901
2907extern obj_template_t *
2908 ncx_get_gen_leaflist (void);
2909
2910
2916extern obj_template_t *
2917 ncx_get_yang_insert (void);
2918
2919
2925extern obj_template_t *
2926 ncx_get_yang_key (void);
2927
2928
2934extern obj_template_t *
2935 ncx_get_yang_value (void);
2936
2937
2944extern obj_template_t *
2945 ncx_get_nc_operation (void);
2946
2947
2954extern obj_template_t *
2955 ncx_get_datapath_obj (void);
2956
2957
2964extern obj_template_t *
2966
2967
2974extern obj_template_t *
2975 ncx_get_btype_obj (void);
2976
2977
2983extern boolean
2985
2986 // END ncxlib/ncxglobals/ncxgenobj
2988
2989
2990 // BEGIN ncxlib/ncxglobals/ncxgenvar
3001
3002
3008extern ncx_display_mode_t
3009 ncx_get_display_mode (void);
3010
3011
3017extern uint32
3019
3020
3028extern boolean
3029 ncx_get_useprefix (void);
3030
3031
3039extern void
3040 ncx_set_useprefix (boolean val);
3041
3042
3050extern boolean
3051 ncx_get_system_sorted (void);
3052
3053
3061extern void
3062 ncx_set_system_sorted (boolean val);
3063
3064
3073extern ncx_sort_type_t
3075
3076
3083extern void
3085
3086
3096extern boolean
3097 ncx_get_cwd_subdirs (void);
3098
3099
3107extern boolean
3109
3110
3117extern void
3119
3120
3126extern void
3128
3129
3137extern void
3138 ncx_set_use_deadmodQ (void);
3139
3140
3150extern int8
3152
3153
3160extern void
3161 ncx_set_message_indent (int8 msg_indent);
3162
3163
3170extern boolean
3172
3173
3180extern status_t
3182
3183
3189extern boolean
3190 ncx_fastpath_enabled (void);
3191
3192
3198extern boolean
3199 ncx_netconfd_running (void);
3200
3201
3207extern void
3208 ncx_use_data_templates (boolean enabled);
3209
3210
3216extern boolean
3217 ncx_data_templates_ok (void);
3218
3219
3225extern void
3226 ncx_ignore_missing_vars (boolean enabled);
3227
3228
3234extern boolean
3235 ncx_missing_vars_ok (void);
3236
3237
3241extern void
3243
3244
3248extern void
3250
3256extern boolean
3258
3259
3266extern status_t
3267 ncx_set_subsys_id (const xmlChar *id);
3268
3274extern const xmlChar *
3275 ncx_get_subsys_id (void);
3276
3277
3282extern void
3283 ncx_set_use_objptrs (void);
3284
3292extern boolean
3293 ncx_use_objptrs (void);
3294
3295
3301extern ncx_backptr_t *
3302 ncx_first_objptr (void);
3303
3304
3311extern ncx_backptr_t *
3313
3314
3315#ifdef DEBUG
3320extern void
3321 ncx_dump_objptrQ (void);
3322#endif // DEBUG
3323
3324
3332extern void
3333 ncx_set_getbulk_max (uint32 max_entries);
3334
3335
3341extern uint32
3342 ncx_get_getbulk_max (void);
3343
3344
3350extern void
3352
3353
3359extern boolean
3361
3362
3372extern void
3374
3375
3382extern boolean
3384
3385
3393extern boolean
3394 ncx_base_schema_set (void);
3395
3396
3402extern void
3403 ncx_set_base_schema (void);
3404
3405
3414extern boolean
3415 ncx_need_get2_xpath (void);
3416
3417
3424extern void
3425 ncx_set_with_ocpattern (boolean mode);
3426
3427
3433extern boolean
3435
3436
3442extern void
3444
3445
3453extern boolean
3454 ncx_is_with_snmp (void);
3455
3456
3464extern void
3465 ncx_set_with_snmp (boolean val);
3466
3467
3473extern void
3474 ncx_enable_bestmatch (void);
3475
3476
3485extern status_t
3486 ncx_set_bestmatch (void);
3487
3488
3496extern boolean
3497 ncx_get_bestmatch (void);
3498
3499
3505extern void
3507
3508
3515extern boolean
3517
3518
3524extern boolean
3526
3527
3534extern void
3535 ncx_set_sethook_registered (boolean val);
3536
3537
3543extern void
3544 ncx_set_binary_display_maxlen (uint32 val);
3545
3546
3552extern uint32
3554
3555
3561extern boolean
3562 ncx_is_with_dblock (void);
3563
3564
3570extern void
3571 ncx_set_with_dblock (boolean val);
3572
3573
3580extern boolean
3582
3583
3589extern void
3590 ncx_set_db_lock_init_done (boolean val);
3591
3592
3598extern void
3599 ncx_set_max_strlen (int32 num);
3600
3601
3607extern int32
3608 ncx_get_max_strlen (void);
3609
3610
3615extern void
3617
3618
3624extern boolean
3626
3627
3632extern void
3634
3635
3641extern boolean
3643
3644
3654extern void
3655 ncx_set_trim_whitespace (boolean val);
3656
3657
3664extern boolean
3666
3667
3676extern void
3677 ncx_set_startup_prune (boolean val);
3678
3679
3688extern boolean
3689 ncx_get_startup_prune (void);
3690
3691
3701extern boolean
3703
3704
3712extern void
3714
3715
3721extern ncx_config_state_t
3722 ncx_get_config_state (void);
3723
3724
3732extern void
3733 ncx_set_xmlorder (boolean val);
3734
3735
3742extern boolean
3743 ncx_get_xmlorder (void);
3744
3745
3753extern void
3754 ncx_set_list_deleteall_ok (boolean val);
3755
3756
3764extern boolean
3766
3767
3775extern void
3776 ncx_set_leaflist_deleteall_ok (boolean val);
3777
3778
3786extern boolean
3788
3789
3797extern boolean
3799
3800
3807extern void
3808 ncx_set_with_canonical (boolean val);
3809
3810
3817extern boolean
3819
3820
3830extern void
3831 ncx_set_save_owners (boolean val);
3832
3833
3840extern boolean
3841 ncx_get_save_owners (void);
3842
3843 // END ncxlib/ncxglobals/ncxgenvar
3845
3846
3847// heading only
3848 // BEGIN ncxlib/ncxstrenum
3866
3867
3876extern const xmlChar *
3877 ncx_get_layer (ncx_layer_t layer);
3878
3879
3886extern ncx_cvttyp_t
3887 ncx_get_cvttyp_enum (const char *str);
3888
3889
3896extern ncx_status_t
3897 ncx_get_status_enum (const xmlChar *str);
3898
3899
3906extern const xmlChar *
3908
3909
3916extern ncx_data_class_t
3917 ncx_get_data_class_enum (const xmlChar *str);
3918
3919
3926extern const xmlChar *
3928
3929
3936extern const xmlChar *
3937 ncx_get_access_str (ncx_access_t max_access);
3938
3939
3946extern ncx_access_t
3947 ncx_get_access_enum (const xmlChar *str);
3948
3949
3958extern boolean
3959 ncx_is_true (const xmlChar *str);
3960
3961
3969extern boolean
3970 ncx_is_false (const xmlChar *str);
3971
3972
3979extern ncx_bad_data_t
3980 ncx_get_baddata_enum (const xmlChar *valstr);
3981
3982
3989extern const xmlChar *
3991
3992
3999extern const xmlChar *
4001
4002
4009extern ncx_withdefaults_t
4010 ncx_get_withdefaults_enum (const xmlChar *withdefstr);
4011
4012
4019extern int32
4020 ncx_get_withdefaults_value (const xmlChar *withdefstr);
4021
4022
4030extern ncx_display_mode_t
4031 ncx_get_display_mode_enum (const xmlChar *dmstr);
4032
4033
4040extern const xmlChar *
4042
4043
4050extern const xmlChar *
4052
4053
4062extern const xmlChar *
4063 ncx_get_protocols_enabled (uint16 flags);
4064
4065
4072extern const xmlChar *
4074
4075
4082extern ncx_name_match_t
4083 ncx_get_name_match_enum (const xmlChar *str);
4084
4085
4092extern const xmlChar *
4094
4095
4102extern int32
4104
4105
4114extern status_t
4115 ncx_str2txid (const xmlChar *str,
4116 ncx_transaction_id_t *txid);
4117
4118
4127extern status_t
4129 xmlChar **retbuff);
4130
4131
4138extern const xmlChar *
4140
4141
4148extern const xmlChar *
4150
4151
4160extern const xmlChar *
4162
4163
4170extern ncx_msg_encoding_t
4171 ncx_cvt_encoding_str (const xmlChar *msg_encoding);
4172
4173
4182extern ncx_msg_encoding_t
4183 ncx_cvt_encoding_yang_str (const xmlChar *msg_encoding);
4184
4185
4191extern const xmlChar *
4193
4194
4201extern const xmlChar *
4203
4204 // END ncxlib/ncxutil/ncxstrenum
4206
4207
4208
4228extern void
4230 ncx_module_t *mod,
4231 status_t res);
4232
4233
4247extern void
4249 ncx_module_t *mod,
4250 status_t res,
4251 const char *filename,
4252 uint32 linenum,
4253 boolean fineoln);
4254
4255
4263extern void
4265 status_t result,
4266 const char *expstr);
4267
4268
4277extern void
4279 ncx_module_t *mod,
4280 status_t result,
4281 const char *expstr);
4282
4283
4293extern void
4295 ncx_module_t *mod,
4296 const char *stmtstr,
4297 const char *expstr);
4298
4299
4310extern ncx_errmsg_t *
4312 const xmlChar *str);
4313
4314
4320extern void
4322
4323
4324 // END ncxlib/yang/yangcomp/yangcomperr
4326
4327
4328 // BEGIN ncxlib/yang/yangcomp/yangcompidentifier
4338
4339
4346extern boolean
4347 ncx_valid_name_ch (uint32 ch);
4348
4349
4356extern boolean
4357 ncx_valid_fname_ch (uint32 ch);
4358
4359
4367extern boolean
4368 ncx_valid_name (const xmlChar *str,
4369 uint32 len);
4370
4371
4385extern boolean
4386 ncx_valid_num_name (const xmlChar *str);
4387
4388
4397extern boolean
4398 ncx_valid_name2 (const xmlChar *str);
4399
4400 // END ncxlib/yang/yangcomp/yangcompidentifier
4402
4403
4404 // BEGIN ncxlib/ncxutil/ncxutilgen
4412
4435extern xmlChar *
4436 ncx_get_source_ex (const xmlChar *fspec,
4437 boolean expand_cwd,
4438 status_t *res);
4439
4440
4463extern xmlChar *
4464 ncx_get_source (const xmlChar *fspec,
4465 status_t *res);
4466
4467
4477extern boolean
4478 ncx_prefix_different (const xmlChar *prefix1,
4479 const xmlChar *prefix2,
4480 const xmlChar *modprefix);
4481
4482
4492extern status_t
4493 ncx_get_version (xmlChar *buffer,
4494 uint32 buffsize);
4495
4496
4506extern status_t
4507 ncx_get_semver (xmlChar *buffer,
4508 uint32 buffsize);
4509
4510
4520extern status_t
4521 ncx_get_full_version (xmlChar *buffer,
4522 uint32 buffsize);
4523
4524
4525
4533extern const char *
4534 ncx_get_build_date (void);
4535
4536
4537
4545extern status_t
4546 ncx_get_feature_code (xmlChar *buffer,
4547 uint32 buffsize);
4548
4557extern int32
4558 ncx_compare_base_uris (const xmlChar *str1,
4559 const xmlChar *str2);
4560
4561
4570extern boolean
4572 uint16 flags);
4573
4574
4575
4585extern void
4587 uint16 *flags);
4588
4589
4598extern void
4600 uint16 *flags);
4601
4602
4609extern boolean
4611
4612
4621extern void
4622 ncx_write_tracefile (const char *buff, uint32 count);
4623
4624
4635extern status_t
4636 ncx_decode_url_string (const xmlChar *urlstr,
4637 uint32 urlstrlen,
4638 xmlChar *buffer,
4639 uint32 *cnt);
4640
4641
4642
4653extern status_t
4654 ncx_create_pidfile (const xmlChar *progname,
4655 boolean fileloc_fhs);
4656
4657
4664extern status_t
4665 ncx_add_ydtrace (const xmlChar *fspec);
4666
4667
4674extern boolean
4675 ncx_find_ydtrace (const xmlChar *fspec);
4676
4677
4686 ncx_get_file_result_format (const xmlChar *filespec);
4687
4688
4701extern boolean
4702 ncx_library_mode_ok (const xmlChar *modname,
4703 const xmlChar *rpcname);
4704
4705
4711extern const char *
4712 ncx_get_progname (void);
4713
4714
4721extern boolean
4723
4724
4732extern boolean
4733 ncx_check_inline_data_state (const xmlChar *line,
4734 boolean curstate);
4735
4736 // END ncxlib/ncxutil/ncxutilgen
4738
4739
4740
4741// Heading Only
4766extern void
4767 ncx_set_cur_modQ (dlq_hdr_t *que);
4768
4769
4773extern void
4774 ncx_reset_modQ (void);
4775
4776
4791extern void
4792 ncx_set_session_modQ (dlq_hdr_t *que);
4793
4794
4800extern dlq_hdr_t *
4801 ncx_get_session_modQ (void);
4802
4803
4816extern void
4818
4819
4825extern void
4826 ncx_set_temp_modQ (dlq_hdr_t *modQ);
4827
4828
4834extern dlq_hdr_t *
4835 ncx_get_temp_modQ (void);
4836
4837
4842extern void
4843 ncx_clear_temp_modQ (void);
4844
4845
4846 // END ncxlib/yang/yanglib/yanglibconf/yanglibconfq
4848
4849
4866extern status_t
4868
4869
4875extern void
4877
4878
4885extern status_t
4887
4888
4894extern void
4896
4897
4904extern status_t
4906
4907
4913extern void
4915
4916
4923extern void
4925 obj_template_t *obj);
4926
4927
4933extern void
4935
4936
4943extern const xmlChar *
4945
4946 // END ncxlib/yang/yanglib/yanglibconf/yanglibconfcb
4948
4965extern void
4966 ncx_set_warn_idlen (uint32 warnlen);
4967
4968
4974extern uint32
4975 ncx_get_warn_idlen (void);
4976
4977
4983extern void
4984 ncx_set_warn_linelen (uint32 warnlen);
4985
4986
4992extern uint32
4993 ncx_get_warn_linelen (void);
4994
4995
5005extern void
5007 ncx_module_t *mod,
5008 const xmlChar *id);
5009
5010
5020extern void
5022 ncx_module_t *mod,
5023 const xmlChar *line);
5024
5025
5032extern status_t
5034
5035
5042extern status_t
5044
5045
5052extern status_t
5054
5055
5061extern void
5062 ncx_set_warn_error (boolean val);
5063
5064
5070extern void
5071 ncx_set_warn_off_yang (boolean val);
5072
5073
5079extern boolean
5080 ncx_get_warn_off_yang (void);
5081
5089extern boolean
5091
5092
5100extern boolean
5102
5103
5110extern void
5112
5113
5129extern void
5130 ncx_set_top_mandatory_allowed (boolean allowed);
5131
5132
5139extern boolean
5141
5142
5152extern boolean
5154
5155
5161extern void
5162 ncx_set_module_setid (uint32 new_setid);
5163
5164
5170extern uint32
5171 ncx_get_module_setid (void);
5172
5173
5183extern status_t
5184 ncx_sprintf_module_setid (uint32 id,
5185 xmlChar *buff,
5186 int32 buffsize);
5187
5188
5195extern boolean
5197
5198
5205extern void
5206 ncx_set_empty_npcon_presence (boolean val);
5207
5208
5218extern boolean
5220
5221
5232extern void
5233 ncx_set_empty_npcon_presence_ro (boolean val);
5234
5235
5236
5237
5238 // END ncxlib/yang/yanglib/yanglibconf/yanglibconfset
5240
5241
5242
5243
5244 // BEGIN ncxlib/ncxutil/ncxbackptr
5259
5260
5267extern ncx_backptr_t *
5268 ncx_new_backptr (void *node);
5269
5270
5277extern void
5279
5280
5291extern void
5293
5294
5300extern void
5301 ncx_clean_backptrQ (dlq_hdr_t *backptrQ);
5302
5303
5310extern void
5311 ncx_clean_mbackptrQ (dlq_hdr_t *backptrQ);
5312
5313
5320extern ncx_backptr_t *
5321 ncx_first_backptr (dlq_hdr_t *que);
5322
5323
5330extern const ncx_backptr_t *
5331 ncx_first_const_backptr (const dlq_hdr_t *que);
5332
5333
5340extern ncx_backptr_t *
5341 ncx_last_backptr (dlq_hdr_t *que);
5342
5343
5350extern ncx_backptr_t *
5352
5359extern const ncx_backptr_t *
5360 ncx_next_const_backptr (const ncx_backptr_t *curptr);
5361
5362
5369extern ncx_backptr_t *
5371
5372
5379extern void *
5381
5382
5389extern const void *
5391
5392
5398extern void
5400
5401
5409extern ncx_backptr_t *
5410 ncx_find_backptr (const dlq_hdr_t *que,
5411 void *node);
5412
5413
5414
5415 // END ncxlib/ncxutil/ncxbackptr
5417
5418
5440extern ncx_save_deviations_t *
5441 ncx_find_save_deviations (const xmlChar *deviname,
5442 dlq_hdr_t *deviationQ);
5443
5444
5450extern void
5452
5453
5462extern boolean
5463 ncx_ok_skip_deviation_module (const xmlChar *modname,
5464 dlq_hdr_t *save_deviationsQ);
5465
5466
5467 // END ncxlib/yang/yangdata/yangdeviation
5469
5470
5471
5472 // BEGIN ncxlib/ncxutil/ncxutilfile
5480
5481
5487extern void
5488 ncx_socket_close (int fd);
5489
5500extern void
5501 ncx_socket_close_noerr (int fd);
5502
5503
5509extern void
5510 ncx_file_close (FILE *fp);
5511
5512
5520extern status_t
5521 ncx_file_remove (const xmlChar *filespec,
5522 boolean do_warn);
5523
5524
5533extern status_t
5534 ncx_file_rename (const xmlChar *old_filespec,
5535 const xmlChar *new_filespec,
5536 boolean do_warn);
5537
5538
5546 extern status_t
5547 ncx_file_flush (FILE *fp,
5548 boolean do_warn);
5549
5550
5558extern status_t
5559 ncx_file_copy (const xmlChar *src_filespec,
5560 const xmlChar *dst_filespec);
5561
5562
5571extern status_t
5572 ncx_file_buffcopy (const xmlChar *src_buff,
5573 uint32 src_bufflen,
5574 const xmlChar *dst_filespec);
5575
5576
5585extern status_t
5586 ncx_file_size (const char *filespec,
5587 uint32 *siz);
5588
5589
5599extern status_t
5600 ncx_file_to_buffer (const char *filespec,
5601 xmlChar **outbuff);
5602
5610extern status_t
5611 ncx_buffer_to_file (const char *filespec,
5612 const xmlChar *inbuff);
5613
5614
5624extern status_t
5625 ncx_get_temp_filespec (xmlChar *buff,
5626 uint32 bufflen,
5627 const xmlChar *rootpart,
5628 const xmlChar *ext);
5629
5630
5640extern ncx_modcache_t *
5641 ncx_new_modcache (const xmlChar *modname,
5642 boolean hidemod);
5643
5644
5650extern void
5652
5653
5654 // END ncxlib/ncxutil/ncxutilfile
5656
5657
5658
5670extern void ncx_set_use_return_status (void);
5671
5672
5673
5679extern boolean ncx_use_return_status (void);
5680
5681
5688extern ncx_bad_reply_enum
5689 ncx_get_handle_badreply_enum (const xmlChar *valstr);
5690
5691
5698extern const xmlChar *
5700
5701
5707extern void
5709
5710
5716extern ncx_bad_reply_enum
5718
5719
5728extern boolean
5730
5731
5732
5742extern ncx_etag_t
5744
5745
5752extern const xmlChar *
5754
5755
5762extern uint16
5764
5765
5771extern dlq_hdr_t *
5772 ncx_get_rootQ (void);
5773
5774
5780extern ncx_sm_rootcb_t *
5781 ncx_first_rootcb (void);
5782
5783
5791extern ncx_sm_rootcb_t *
5793
5794
5805extern boolean
5806 ncx_is_sm_mode (void);
5807
5808
5819extern void
5820 ncx_set_sm_mode (boolean val);
5821
5822
5830extern ncx_sm_rootcb_t *
5831 ncx_get_cur_rootcb (void);
5832
5833
5841extern void
5843
5844
5852extern obj_template_t *
5854
5855
5856
5867extern boolean
5868 ncx_get_sm_enabled (void);
5869
5870
5876extern void
5877 ncx_set_sm_enabled (boolean val);
5878
5884extern boolean
5885 ncx_yang_cbor_enabled (void);
5886
5892extern unsigned short
5894
5895
5901extern void
5902 ncx_set_tcp_connect_timeout (unsigned short timeout_sec);
5903
5904
5913extern ncx_module_t *
5914 ncx_find_module_que_all (dlq_hdr_t *modQ,
5915 const xmlChar *modname,
5916 const xmlChar *revision);
5926extern void
5927 ncx_invoke_load_callbacks (ncx_module_t *mod);
5928
5937extern void
5938 ncx_redo_loadmod_all (void);
5939
5940
5946extern void
5948
5949
5955extern boolean
5957
5963extern void
5965
5966
5973extern boolean
5974 ncx_save_error_input (void);
5975
5981extern void
5983
5991extern boolean
5992 ncx_mod_parse_done (const ncx_module_t *mod);
5993
5994
6001extern status_t ncx_set_chunk_size (uint16 chunksize);
6002
6003
6009extern uint16 ncx_get_chunk_size (void);
6010
6011
6024extern const xmlChar *
6025 ncx_get_real_notif_modname (const xmlChar *modname,
6026 const xmlChar *name);
6027
6028
6041extern const xmlChar *
6042 ncx_get_fake_notif_modname (const xmlChar *modname,
6043 const xmlChar *name);
6044
6045
6060extern void
6061 ncx_set_mod_stable (boolean state);
6062
6063
6070extern boolean
6071 ncx_get_mod_stable (void);
6072
6073
6079extern void
6080 ncx_set_yang_metadata (boolean state);
6081
6082
6088extern boolean
6089 ncx_get_yang_metadata (void);
6090
6091
6097extern ncx_sid_range_t *
6098 ncx_new_sid_range (void);
6099
6100
6106extern void
6108
6109
6115extern void
6116 ncx_clean_sid_rangeQ (dlq_hdr_t *sid_rangeQ);
6117
6118 // END ncxlib/ncxutil/ncxutilfile
6120
6121#ifdef __cplusplus
6122} /* end extern 'C' */
6123#endif
6124
6125#endif /* _H_ncx */
dlq provides general double-linked list and queue support:
GET1 and GET2 Callback Support.
log_debug_t
The debug level enumerations used in util/log.c.
Definition: log.h:348
status_t
global error return code
Definition: status_enum.h:219
uint16 xmlns_id_t
integer handle for registered namespaces
Definition: xmlns.h:89
const ncx_backptr_t * ncx_first_const_backptr(const dlq_hdr_t *que)
Get first back pointer struct CONST.
Definition: ncx.c:13336
void ncx_free_mbackptr(ncx_backptr_t *ptr)
Free an ncx_backptr_t struct; Free the 'node' pointer first.
Definition: ncx.c:13255
void ncx_clean_backptrQ(dlq_hdr_t *backptrQ)
Clean an entire Q of ncx_backptr_t structs.
Definition: ncx.c:13274
ncx_backptr_t * ncx_first_backptr(dlq_hdr_t *que)
Get first back pointer struct.
Definition: ncx.c:13317
ncx_backptr_t * ncx_new_backptr(void *node)
Malloc and initialize a new ncx_backptr_t struct.
Definition: ncx.c:13216
ncx_backptr_t * ncx_next_backptr(ncx_backptr_t *curptr)
Get next back pointer struct.
Definition: ncx.c:13374
ncx_backptr_t * ncx_last_backptr(dlq_hdr_t *que)
Get last back pointer struct.
Definition: ncx.c:13355
ncx_backptr_t * ncx_find_backptr(const dlq_hdr_t *que, void *node)
Find the specified back pointer struct.
Definition: ncx.c:13488
void * ncx_get_backptr_node(ncx_backptr_t *backptr)
Get the back pointer node pointer.
Definition: ncx.c:13431
void ncx_free_backptr(ncx_backptr_t *ptr)
Free an ncx_backptr_t struct.
Definition: ncx.c:13237
ncx_backptr_t * ncx_prev_backptr(ncx_backptr_t *curptr)
Get previous back pointer struct.
Definition: ncx.c:13412
const void * ncx_get_const_backptr_node(const ncx_backptr_t *backptr)
Get the back pointer node pointer CONST.
Definition: ncx.c:13450
void ncx_clean_mbackptrQ(dlq_hdr_t *backptrQ)
Clean an entire Q of ncx_backptr_t structs Use ncx_free_mbackptr to free node pointers.
Definition: ncx.c:13296
const ncx_backptr_t * ncx_next_const_backptr(const ncx_backptr_t *curptr)
Get next back pointer struct CONST.
Definition: ncx.c:13393
void ncx_remove_backptr(ncx_backptr_t *ptr)
Remove the specified backptr for deletion.
Definition: ncx.c:13468
boolean ncx_obj_is_generic(const obj_template_t *obj)
Check if the object is 1 of the gen_foo object templates.
Definition: ncx.c:15097
obj_template_t * ncx_get_btype_obj(void)
Get the cached datapath meta-object template used to contruct a metaval for the attribute.
Definition: ncx.c:13642
obj_template_t * ncx_get_nc_operation(void)
Get the cached operation meta-object template used to contruct a metaval for the attribute.
Definition: ncx.c:13542
obj_template_t * ncx_get_yang_insert(void)
Get the object template for the YANG insert attribute.
Definition: ncx.c:7987
obj_template_t * ncx_get_yang_value(void)
Get the object template for the YANG value attribute.
Definition: ncx.c:8013
obj_template_t * ncx_get_gen_root(void)
Get the object template for the NCX generic root container.
Definition: ncx.c:7944
obj_template_t * ncx_get_gen_empty(void)
Get the object template for the NCX generic empty leaf.
Definition: ncx.c:7930
obj_template_t * ncx_get_gen_container(void)
Get the object template for the NCX generic container.
Definition: ncx.c:7902
obj_template_t * ncx_get_fixed_value_obj(void)
Get the cached fixed-value meta-object template used to contruct a metaval for the attribute.
Definition: ncx.c:13609
obj_template_t * ncx_get_yang_key(void)
Get the object template for the YANG key attribute.
Definition: ncx.c:8000
obj_template_t * ncx_get_gen_leaflist(void)
Get the object template for the NCX generic leaf-list string.
Definition: ncx.c:7974
obj_template_t * ncx_get_datapath_obj(void)
Get the cached datapath meta-object template used to contruct a metaval for the attribute.
Definition: ncx.c:13576
obj_template_t * ncx_get_gen_anyxml(void)
Get the object template for the NCX generic anyxml container.
Definition: ncx.c:7888
obj_template_t * ncx_get_gen_binary(void)
Get the object template for the NCX generic binary leaf.
Definition: ncx.c:7959
obj_template_t * ncx_get_gen_string(void)
Get the object template for the NCX generic string leaf.
Definition: ncx.c:7916
boolean ncx_get_pidfile_cleaned(void)
Get the PID file cleaned flag.
Definition: ncx.c:17158
const xmlChar * ncx_get_subsys_id(void)
Get the subsys_id value; NULL if not set.
Definition: ncx.c:14582
boolean ncx_get_startup_prune(void)
Get the startup_prune flag.
Definition: ncx.c:17247
boolean ncx_need_get2_xpath(void)
Check if GET2 callback support needed in XPath.
Definition: ncx.c:15898
boolean ncx_is_with_snmp(void)
Get the with_snmp value.
Definition: ncx.c:16218
boolean ncx_get_search_modQ_ok(void)
Get the search_modQ_ok flag.
Definition: ncx.c:14548
void ncx_set_sil_priority_used(void)
Flag that an object set a non-default SIL priority.
Definition: ncx.c:15036
ncx_backptr_t * ncx_first_objptr(void)
Get the first object pointer.
Definition: ncx.c:14659
boolean ncx_netconfd_running(void)
Check if netconfd running.
Definition: ncx.c:13690
boolean ncx_data_templates_ok(void)
Get the use-data-templates flag.
Definition: ncx.c:14377
uint32 ncx_get_binary_display_maxlen(void)
Get the binary_display_maxlen parameter.
Definition: ncx.c:16996
void ncx_set_binary_display_maxlen(uint32 val)
Set the binary_display_maxlen parameter.
Definition: ncx.c:16980
boolean ncx_get_leaflist_deleteall_ok(void)
Get the leaflist_deleteall_ok flag.
Definition: ncx.c:17408
void ncx_set_base_schema(void)
Set the base_schema_set flag to true.
Definition: ncx.c:15241
boolean ncx_get_sethook_registered(void)
Check if the Set-Hook callbacks were registered.
Definition: ncx.c:16945
uint32 ncx_get_vtimeout_value(void)
Get the virtual node cache timeout value.
Definition: ncx.c:11759
void ncx_set_max_strlen(int32 num)
Set the –max-strlen parameter.
Definition: ncx.c:17082
void ncx_set_protocol_disabled(ncx_protocol_t proto)
Set the specified protocol version to be disabled.
Definition: ncx.c:12091
status_t ncx_set_all_obj_xpath_backptrs(void)
Add Xpath back pointers to the data-db objects in the database.
Definition: ncx.c:13156
void ncx_set_save_owners(boolean val)
Set the save_owners flag.
Definition: ncx.c:17479
void ncx_set_trim_whitespace(boolean val)
Set the trim_whitespace flag.
Definition: ncx.c:17199
boolean ncx_get_secondary_sil_priority_used(void)
Get the secondary_sil_priority_used flag.
Definition: ncx.c:15084
boolean ncx_protocol_enabled(ncx_protocol_t proto)
Check if the specified protocol version is enabled.
Definition: ncx.c:11971
ncx_sort_type_t ncx_get_system_sort_type(void)
Get the system_sort_type value.
Definition: ncx.c:11897
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.
Definition: ncx.c:17427
boolean ncx_get_cwd_subdirs(void)
Get the CLI parameter value whether to search for modules in subdirs of the CWD by default.
Definition: ncx.c:11955
boolean ncx_get_with_canonical(void)
Get the with_canonical flag.
Definition: ncx.c:17465
void ncx_set_ypwatcher_running(void)
Set the ypwatcher running flag.
Definition: ncx.c:17112
void ncx_set_db_lock_init_done(boolean val)
Set if the <db-lock-init> message was processed by the server.
Definition: ncx.c:17066
boolean ncx_use_objptrs(void)
Get the use_objptrs flag.
Definition: ncx.c:14644
ncx_display_mode_t ncx_get_display_mode(void)
Get the current default display mode.
Definition: ncx.c:11471
boolean ncx_get_system_sorted(void)
Get the system_sorted value.
Definition: ncx.c:11862
void ncx_set_config_state(ncx_config_state_t val)
Set the config_state flag.
Definition: ncx.c:17261
boolean ncx_get_save_owners(void)
Get the save_owners flag.
Definition: ncx.c:17496
boolean ncx_is_add_toplevel_default_mode(void)
Get the add_toplevel_default_mode value.
Definition: ncx.c:16186
void ncx_set_leaflist_deleteall_ok(boolean val)
Set the leaflist_deleteall_ok flag.
Definition: ncx.c:17391
boolean ncx_use_xpath_backptrs(void)
Check if it is OK to use XPath back pointers or not.
Definition: ncx.c:13140
void ncx_ignore_missing_vars(boolean enabled)
Set the ignore-missing-vars flag.
Definition: ncx.c:14390
void ncx_set_getbulk_max(uint32 max_entries)
Set the max_entries parameter for GET2 callbacks.
Definition: ncx.c:14968
void ncx_set_list_deleteall_ok(boolean val)
Set the list_deleteall_ok flag.
Definition: ncx.c:17360
void ncx_set_system_sorted(boolean val)
Set the system_sorted value.
Definition: ncx.c:11881
status_t ncx_set_bestmatch(void)
Setup the bestmatch module versions, if enabled.
Definition: ncx.c:16336
void ncx_set_with_dblock(boolean val)
Set the is_with_dblock value.
Definition: ncx.c:17030
void ncx_set_search_modQ_ok(void)
Set the search_modQ_ok flag to TRUE.
Definition: ncx.c:14536
void ncx_set_add_toplevel_default_mode(boolean val)
Set the add_toplevel_default_mode value.
Definition: ncx.c:16202
status_t ncx_set_subsys_id(const xmlChar *id)
Set the subsys_id parameter for this subsystem.
Definition: ncx.c:14559
void ncx_allow_get_when_check(void)
Allow server get retrievals to test for false when-stmt during retrieval operations on YANG data.
Definition: ncx.c:16913
void ncx_set_startup_prune(boolean val)
Set the startup_prune flag.
Definition: ncx.c:17230
int8 ncx_get_message_indent(void)
Get the protoco9l output indent amount.
Definition: ncx.c:12564
ncx_config_state_t ncx_get_config_state(void)
Get the config_state flag.
Definition: ncx.c:17278
void ncx_enable_bestmatch(void)
Enable the bestmatch import processing feature.
Definition: ncx.c:16305
boolean ncx_is_db_lock_init_done(void)
Check if the <db-lock-init> message was processed by the server.
Definition: ncx.c:17049
boolean ncx_get_bestmatch(void)
Get the bestmatch module versions, if enabled.
Definition: ncx.c:16318
boolean ncx_base_schema_set(void)
Check if the base schema features have been set yet.
Definition: ncx.c:15229
boolean ncx_get_ypwatcher_running(void)
Get the ypwatcher running flag.
Definition: ncx.c:17128
int32 ncx_get_max_strlen(void)
Get the –max-strlen parameter.
Definition: ncx.c:17098
void ncx_set_useprefix(boolean val)
Set the use_prefix value.
Definition: ncx.c:11845
boolean ncx_get_xmlorder(void)
Get the xmlorder flag.
Definition: ncx.c:17346
void ncx_set_protocol_enabled(ncx_protocol_t proto)
Set the specified protocol version to be enabled.
Definition: ncx.c:12054
boolean ncx_is_with_dblock(void)
Get the is_with_dblock value.
Definition: ncx.c:17013
void ncx_set_ycontrol_running(void)
Set the ycontrol_running flag to TRUE.
Definition: ncx.c:14524
void ncx_set_pidfile_cleaned(void)
Set the pidfile cleaned flag.
Definition: ncx.c:17142
void ncx_set_with_snmp(boolean val)
Set the with_snmp value.
Definition: ncx.c:16235
void ncx_set_with_ocpattern(boolean mode)
Set the openconfig pattern mode for the entire system.
Definition: ncx.c:16171
void ncx_set_xmlorder(boolean val)
Set the xmlorder flag.
Definition: ncx.c:17329
void ncx_set_system_sort_type(ncx_sort_type_t val)
Set the system_sort_type value.
Definition: ncx.c:11916
boolean ncx_missing_vars_ok(void)
Get the ignore-missing-vars flag.
Definition: ncx.c:14403
boolean ncx_get_useprefix(void)
Get the use_prefix value.
Definition: ncx.c:11827
boolean ncx_get_sil_priority_used(void)
Get the sil_priority_used flag.
Definition: ncx.c:15049
boolean ncx_use_get_when_check(void)
Check server get retrievals to test for false when-stmt during retrieval operations on YANG data.
Definition: ncx.c:16928
void ncx_set_use_deadmodQ(void)
Set the usedeadmodQ flag.
Definition: ncx.c:12320
void ncx_set_message_indent(int8 msg_indent)
Set the protocol output message indent amount.
Definition: ncx.c:12580
boolean ncx_get_list_deleteall_ok(void)
Get the list_deleteall_ok flag.
Definition: ncx.c:17377
void ncx_use_data_templates(boolean enabled)
Set the use-data-templates flag.
Definition: ncx.c:14364
boolean ncx_get_trim_whitespace(void)
Get the trim_whitespace flag.
Definition: ncx.c:17216
boolean ncx_fastpath_enabled(void)
Check if fast path value tree comparisons enabled.
Definition: ncx.c:13674
void ncx_set_with_canonical(boolean val)
Set the with_canonical flag.
Definition: ncx.c:17448
ncx_backptr_t * ncx_next_objptr(ncx_backptr_t *curptr)
Get the next object pointer.
Definition: ncx.c:14678
void ncx_set_sethook_registered(boolean val)
Set the sethook_registered value.
Definition: ncx.c:16963
uint32 ncx_get_getbulk_max(void)
Get the max_entries parameter for GET2 callbacks.
Definition: ncx.c:14980
void ncx_set_secondary_sil_priority_used(void)
Flag that a value node set a non-default secondary SIL priority.
Definition: ncx.c:15068
boolean ncx_check_startup_prune(ses_cb_t *scb)
Check if the namespace error can be skipped.
Definition: ncx.c:17299
void ncx_set_use_objptrs(void)
Set the use_objptrs flag.
Definition: ncx.c:14628
void ncx_cleanup(void)
Cleanup the NCX library.
Definition: ncx.c:3464
status_t ncx_init(boolean netconfd, boolean savestr, log_debug_t dlevel, boolean logtstamps, boolean collapse_submods, boolean xpath_backptrs, const char *startmsg, int argc, char *argv[])
Initialize the NCX library.
Definition: ncx.c:2977
const xmlChar * ncx_get_display_mode_str(ncx_display_mode_t dmode)
Get the string for the specified enum value.
Definition: ncx.c:10572
int32 ncx_get_name_match_value(ncx_name_match_t match)
Get the YANG integer value for the ncx_name_match_t enum.
Definition: ncx.c:12476
const xmlChar * ncx_cvt_encoding_enum(ncx_msg_encoding_t msg_encoding)
Convert an ncx_msg_encoding_t enum to a string.
Definition: ncx.c:14840
const xmlChar * ncx_get_yang_version_str(ncx_yang_version_t langver)
Get the yang-version string value for the enum.
Definition: ncx.c:14992
const xmlChar * ncx_get_btyp_string(ncx_btype_t btyp)
Get the enumeration string to the base type enum.
Definition: ncx.c:14239
ncx_access_t ncx_get_access_enum(const xmlChar *str)
Get the enum for the string name of a ncx_access_t enum.
Definition: ncx.c:8702
const xmlChar * ncx_get_protocols_enabled(uint16 flags)
Get the string for the NETCONF protocols enabled in the flags.
Definition: ncx.c:12219
status_t ncx_str2txid(const xmlChar *str, ncx_transaction_id_t *txid)
Convert a string to a ncx_transaction_id_t.
Definition: ncx.c:14094
ncx_msg_encoding_t ncx_cvt_encoding_str(const xmlChar *msg_encoding)
Convert a ncx_msg_encoding_t string to its enum.
Definition: ncx.c:14903
const xmlChar * ncx_get_baddata_string(ncx_bad_data_t baddata)
Get the string for the specified enum value.
Definition: ncx.c:10100
ncx_name_match_t ncx_get_name_match_enum(const xmlChar *str)
Get the enum for the string name of a ncx_name_match_t enum.
Definition: ncx.c:12399
ncx_withdefaults_t ncx_get_withdefaults_enum(const xmlChar *withdefstr)
Get the enum for the specified string value.
Definition: ncx.c:10168
const xmlChar * ncx_get_data_class_str(ncx_data_class_t dataclass)
Get the string value for the ncx_data_class_t enum.
Definition: ncx.c:8654
const xmlChar * ncx_get_protocol_name(ncx_protocol_t proto)
Get the name string for the protocol.
Definition: ncx.c:12259
const xmlChar * ncx_get_withdefaults_string(ncx_withdefaults_t withdef)
Get the string for the specified enum value.
Definition: ncx.c:10134
status_t ncx_txid2str(ncx_transaction_id_t *txid, xmlChar **retbuff)
Convert a transaction ID to a string.
Definition: ncx.c:14131
const xmlChar * ncx_get_access_str(ncx_access_t max_access)
Get the string name of a ncx_access_t enum.
Definition: ncx.c:8680
const xmlChar * ncx_get_name_match_string(ncx_name_match_t match)
Get the string for the ncx_name_match_t enum.
Definition: ncx.c:12438
ncx_status_t ncx_get_status_enum(const xmlChar *str)
Get the enum for the string name of a ncx_status_t enum.
Definition: ncx.c:8151
const xmlChar * ncx_get_confirm_event_str(ncx_confirm_event_t event)
Get the string for the specified enum value.
Definition: ncx.c:11491
const xmlChar * ncx_get_status_string(ncx_status_t status)
Get the string for the enum value of a ncx_status_t enum.
Definition: ncx.c:8180
ncx_data_class_t ncx_get_data_class_enum(const xmlChar *str)
Get the enum for the string name of a ncx_data_class_t enum.
Definition: ncx.c:8629
ncx_msg_encoding_t ncx_cvt_encoding_yang_str(const xmlChar *msg_encoding)
Convert a ncx_msg_encoding_t string to its YANG enum.
Definition: ncx.c:14936
boolean ncx_is_false(const xmlChar *str)
Check if an xmlChar string is a string OK for XSD boolean.
Definition: ncx.c:9000
const xmlChar * ncx_cvt_encoding_yang_enum(ncx_msg_encoding_t msg_encoding)
Convert an ncx_msg_encoding_t enum to a YANG string.
Definition: ncx.c:14872
const xmlChar * ncx_get_ses_event_str(ncx_ses_event_t ses_event)
Get the session event string for the enum.
Definition: ncx.c:17174
const xmlChar * ncx_get_layer(ncx_layer_t layer)
Translate ncx_layer_t enum to a string.
Definition: ncx.c:8030
ncx_bad_data_t ncx_get_baddata_enum(const xmlChar *valstr)
Check if the specified string matches an ncx_baddata_t enum.
Definition: ncx.c:10064
boolean ncx_is_true(const xmlChar *str)
Check if an xmlChar string is a string OK for XSD boolean.
Definition: ncx.c:8974
int32 ncx_get_withdefaults_value(const xmlChar *withdefstr)
Get the YANG integer value for the enum for the specified string value.
Definition: ncx.c:10203
ncx_cvttyp_t ncx_get_cvttyp_enum(const char *str)
Get the enum for the string name of a ncx_cvttyp_t enum.
Definition: ncx.c:8095
ncx_display_mode_t ncx_get_display_mode_enum(const xmlChar *dmstr)
Get the enum for the specified string value.
Definition: ncx.c:10528
ncx_node_t
NCX Internal Node Types.
Definition: ncxtypes.h:460
ncx_status_t
enumeration for different YANG data-def status values
Definition: ncxtypes.h:607
uint32 ncx_etag_t
The ETag used in RESTCONF messages is the lower 32 bits of a ncx_transaction_id_t.
Definition: ncxtypes.h:777
ncx_ses_event_t
internal enumerations for session event types
Definition: ncxtypes.h:1757
ncx_confirm_event_t
type of confirmEvent in the sysConfirmedCommit notification Used in confirmed-commit standard as well
Definition: ncxtypes.h:1569
void(* ncx_yang_obj_cbfn_t)(ncx_module_t *mod, struct obj_template_t_ *obj)
user function callback template when a YANG object is parsed by yang_obj.c.
Definition: ncxtypes.h:1496
ncx_sort_type_t
the sort type enumeration used for system-ordered list aand leaf-list objects
Definition: ncxtypes.h:1855
ncx_cvttyp_t
enumeration for different NCX module conversion output types
Definition: ncxtypes.h:1309
ncx_yang_version_t
enumeration for different YANG language versions
Definition: ncxtypes.h:1049
ncx_tclass_t
Enumeration of the basic value type classifications.
Definition: ncxtypes.h:430
uint64 ncx_transaction_id_t
transaction is scoped to single session write operation on a config
Definition: ncxtypes.h:752
ncx_msg_encoding_t
enumeration for message encoding formats
Definition: ncxtypes.h:671
ncx_protocol_t
NCX session protocol versions supported.
Definition: ncxtypes.h:1036
ncx_btype_t
enumeration of the built-in NCX types These types cannot be overridden and cannot be imported
Definition: ncxtypes.h:236
ncx_access_t
NCX Access Control 'max-access' enumeration values Note that access control is applied to the session...
Definition: ncxtypes.h:205
void(* ncx_unload_cbfn_t)(ncx_module_t *mod)
user function callback template when a module is unloaded from the system
Definition: ncxtypes.h:1476
boolean(* ncx_identity_cbfn_t)(ncx_identity_t *identity, void *cookie)
user function callback template to traverse all module identities looking for matches for a specified...
Definition: ncxtypes.h:1604
ncx_bad_reply_enum
enumeration for CLI handling of bad nodes from RPC reply Controls the behavior of the MGR XML parser
Definition: ncxtypes.h:1812
ncx_data_class_t
NCX Persistence Control.
Definition: ncxtypes.h:226
uint8 ncx_owner_id_t
used as index into the agt_owner registry
Definition: ncxtypes.h:1608
const xmlChar *(* ncx_get_owner_fn_t)(ncx_owner_id_t owner_id)
get owner name callback function to check if a value node has an owner name; get the value if so
Definition: ncxtypes.h:1619
ncx_opt_t
enum for REQUIRED vs.
Definition: ncxtypes.h:1404
ncx_bad_data_t
enumeration for CLI handling of bad input data used by yangcli, all others use NCX_BAD_DATA_ERROR
Definition: ncxtypes.h:618
ncx_name_match_t
Node name match modes.
Definition: ncxtypes.h:719
ncx_layer_t
Enumeration of NETCONF protocol layers.
Definition: ncxtypes.h:530
ncx_result_format_t
specify the requested result format type Used by yangcli-pro assign statement
Definition: ncxtypes.h:743
boolean(* ncx_object_cbfn_t)(const ncx_module_t *mod, struct obj_template_t_ *object, void *cookie)
user function callback template to traverse all module objects for a specified module
Definition: ncxtypes.h:1517
ncx_xpath_type_t
enumeration for different XPath back pointer types
Definition: ncxtypes.h:1341
ncx_config_state_t
server config state Root Check
Definition: ncxtypes.h:1765
ncx_display_mode_t
enumeration of val_dump_value display modes Some RESTCONF code uses this field incorrectly for messag...
Definition: ncxtypes.h:641
ncx_withdefaults_t
enum for with-defaults enum values
Definition: ncxtypes.h:1332
void(* ncx_load_cbfn_t)(ncx_module_t *mod)
user function callback template when a module is loaded into the system
Definition: ncxtypes.h:1462
status_t ncx_file_rename(const xmlChar *old_filespec, const xmlChar *new_filespec, boolean do_warn)
Rename a file; check result.
Definition: ncx.c:15429
ncx_modcache_t * ncx_new_modcache(const xmlChar *modname, boolean hidemod)
New ncx_modcache_t record.
Definition: ncx.c:16583
status_t ncx_file_remove(const xmlChar *filespec, boolean do_warn)
Close a file; check result.
Definition: ncx.c:15395
status_t ncx_file_buffcopy(const xmlChar *src_buff, uint32 src_bufflen, const xmlChar *dst_filespec)
Copy a buffer to a file; check result.
Definition: ncx.c:15627
void ncx_socket_close_noerr(int fd)
Close a socket; check result; SUPPRESS ERROR MESSAGE.
Definition: ncx.c:15318
void ncx_file_close(FILE *fp)
Close a file; check result.
Definition: ncx.c:15368
void ncx_socket_close(int fd)
Close a socket; check result.
Definition: ncx.c:15343
status_t ncx_file_to_buffer(const char *filespec, xmlChar **outbuff)
Read a text file into a malloced buffer.
Definition: ncx.c:16414
status_t ncx_file_size(const char *filespec, uint32 *siz)
Get a file size.
Definition: ncx.c:16371
status_t ncx_buffer_to_file(const char *filespec, const xmlChar *inbuff)
Write a buffer to a text file.
Definition: ncx.c:16491
status_t ncx_file_copy(const xmlChar *src_filespec, const xmlChar *dst_filespec)
Copy a file; check result.
Definition: ncx.c:15522
void ncx_free_modcache(ncx_modcache_t *mc)
Free a ncx_modcache_t record.
Definition: ncx.c:16612
status_t ncx_file_flush(FILE *fp, boolean do_warn)
Flush file data to disk to prevent corruption on crash/power loss.
Definition: ncx.c:15469
status_t ncx_get_temp_filespec(xmlChar *buff, uint32 bufflen, const xmlChar *rootpart, const xmlChar *ext)
Generate a temporary filespec.
Definition: ncx.c:16637
ncx_sm_rootcb_t * ncx_get_cur_rootcb(void)
Gte the current root control block value.
Definition: ncx.c:17811
void ncx_redo_loadmod_all(void)
Set the redo_loadmod flag for all modules.
Definition: ncx.c:18041
void ncx_set_cur_rootcb(ncx_sm_rootcb_t *rootcb)
Set the current root control block.
Definition: ncx.c:17829
const xmlChar * ncx_get_xpath_type_str(ncx_xpath_type_t xpath_typ)
Get the string for the ncx_xpath_type_t enum.
Definition: ncx.c:17676
boolean ncx_is_sm_mode(void)
Check if the Schema Mount mode is enabled.
Definition: ncx.c:17780
boolean ncx_protocol_is_netconf(ncx_protocol_t proto)
Check if the protocol is a NETCONF protocol.
Definition: ncx.c:12298
void ncx_set_handle_badreply(ncx_bad_reply_enum enumval)
Set the enum value for the Bad Reply handling option.
Definition: ncx.c:17613
void ncx_set_mod_augmented(ncx_module_t *mod)
Set the module as supported because it is being augmented.
Definition: ncx.c:18140
obj_template_t * ncx_get_cur_rootcb_obj(void)
Get the current root control block object.
Definition: ncx.c:17847
void ncx_set_disable_imported(void)
Allow the obj_is_enabled funtion to disable all import-only modules.
Definition: ncx.c:18079
boolean ncx_ok_for_inline_data(obj_template_t *obj)
Check if the object is OK for inline data.
Definition: ncx.c:16693
void ncx_set_sm_enabled(boolean val)
Set schema mount enabled flag.
Definition: ncx.c:17884
int32 ncx_compare_base_uris(const xmlChar *str1, const xmlChar *str2)
Compare the base part of 2 URI strings.
Definition: ncx.c:11781
boolean ncx_check_inline_data_state(const xmlChar *line, boolean curstate)
Check the input line for Start or End of data tags.
Definition: ncx.c:16715
status_t ncx_get_version(xmlChar *buffer, uint32 buffsize)
Get the the Yuma version ID string.
Definition: ncx.c:11112
boolean ncx_use_return_status(void)
Check if the return_status should be returned.
Definition: ncx.c:17542
ncx_bad_reply_enum ncx_get_handle_badreply(void)
Get the enum for the Bad Reply Handling option.
Definition: ncx.c:17626
unsigned short ncx_get_tcp_connect_timeout(void)
Get the configured TCP connect timeout value.
Definition: ncx.c:17919
void ncx_set_sm_mode(boolean val)
Set the Schema Mount mode.
Definition: ncx.c:17796
ncx_etag_t ncx_txid2etag(ncx_transaction_id_t txid)
Cast ncx_txid_t to ncx_etag_t.
Definition: ncx.c:17660
boolean ncx_find_ydtrace(const xmlChar *fspec)
Find the filespec of a yangdump file being processed.
Definition: ncx.c:14345
boolean ncx_prefix_different(const xmlChar *prefix1, const xmlChar *prefix2, const xmlChar *modprefix)
Check if the specified prefix pair reference different modules.
Definition: ncx.c:10030
void ncx_set_save_error_input(void)
Allow the audit-log reporting to show the bad input instead of discarding nodes with invalid-value er...
Definition: ncx.c:18108
const char * ncx_get_progname(void)
Get the progname buffer.
Definition: ncx.c:16253
boolean ncx_mod_parse_done(const ncx_module_t *mod)
Check if the module is completely parsed yet.
Definition: ncx.c:18061
void ncx_set_use_return_status(void)
Enable the return_status parameter.
Definition: ncx.c:17531
boolean ncx_disable_imported_ok(void)
Check if disable all import-only modules OK.
Definition: ncx.c:18092
boolean ncx_get_mod_stable(void)
Get the yangcli flag to indicate the module set loading modules from the server capabilities is in pr...
Definition: ncx.c:18287
status_t ncx_get_feature_code(xmlChar *buffer, uint32 buffsize)
Get the the Feature Code String.
Definition: ncx.c:11004
void ncx_set_tcp_connect_timeout(unsigned short timeout_sec)
Set the configured TCP connect timeout value.
Definition: ncx.c:17935
ncx_sm_rootcb_t * ncx_next_rootcb(ncx_sm_rootcb_t *rootcb)
Get the next Mount Point Entry in the rootcbQ.
Definition: ncx.c:17761
xmlChar * ncx_get_source(const xmlChar *fspec, status_t *res)
Expand a filespec into an absolute path.
Definition: ncx.c:9675
boolean ncx_save_error_input(void)
Check if the error input should be saved instead of discarding nodes with invalid-value errors.
Definition: ncx.c:18123
boolean ncx_yang_cbor_enabled(void)
Get the YANG to CBOR Code enabled flag.
Definition: ncx.c:17900
status_t ncx_add_ydtrace(const xmlChar *fspec)
Add the filespec of a yangdump file being processed.
Definition: ncx.c:14319
status_t ncx_get_semver(xmlChar *buffer, uint32 buffsize)
Get the the Yuma SEMVER version ID string.
Definition: ncx.c:11220
ncx_sm_rootcb_t * ncx_first_rootcb(void)
Get the first Mount Point Control Block Entry in the rootcbQ.
Definition: ncx.c:17746
boolean ncx_library_mode_ok(const xmlChar *modname, const xmlChar *rpcname)
Check if RPC OK to use in library mode.
Definition: ncx.c:15261
status_t ncx_create_pidfile(const xmlChar *progname, boolean fileloc_fhs)
Create the pidfile for the specified program.
Definition: ncx.c:13711
void ncx_set_yang_metadata(boolean state)
Enable the –ietf-yang-metadata module.
Definition: ncx.c:18305
ncx_sid_range_t * ncx_new_sid_range(void)
Malloc a new ncx_sid_range_t.
Definition: ncx.c:18336
void ncx_write_tracefile(const char *buff, uint32 count)
Write a byte to the tracefile.
Definition: ncx.c:12512
void ncx_set_val_protocol_enabled(ncx_protocol_t proto, uint16 *flags)
Set the specified protocol version to be enabled in a uint16 bits val.
Definition: ncx.c:12133
uint16 ncx_get_chunk_size(void)
Get the default chunk size for session buffers.
Definition: ncx.c:18175
ncx_module_t * ncx_find_module_que_all(dlq_hdr_t *modQ, const xmlChar *modname, const xmlChar *revision)
Find a ncx_module_t in the specified Q and check the namespace ID check submodules,...
Definition: ncx.c:17955
xmlChar * ncx_get_source_ex(const xmlChar *fspec, boolean expand_cwd, status_t *res)
Expand a filespec into an absolute path.
Definition: ncx.c:9466
boolean ncx_conf_env_vars_enabled(void)
Get the Config Environment Variable Replacement flag.
Definition: ncx.c:17642
uint16 ncx_get_curQ_mod_count(void)
Get the total count of the currently fully loaded modules in the ncx_curQ.
Definition: ncx.c:17707
ncx_result_format_t ncx_get_file_result_format(const xmlChar *filespec)
Check the filespec string for a file assignment statement to see if it is text, XML,...
Definition: ncx.c:14423
boolean ncx_get_yang_metadata(void)
Get the yang_metadata flag.
Definition: ncx.c:18320
boolean ncx_val_protocol_enabled(ncx_protocol_t proto, uint16 flags)
Check if the specified protocol version is enabled.
Definition: ncx.c:12014
boolean ncx_get_sm_enabled(void)
Get schema mount enabled flag.
Definition: ncx.c:17868
status_t ncx_set_chunk_size(uint16 chunksize)
Set the default chunk size for session buffers.
Definition: ncx.c:18158
ncx_bad_reply_enum ncx_get_handle_badreply_enum(const xmlChar *valstr)
Check if the specified string matches an ncx_bad_reply_enum enum.
Definition: ncx.c:17560
status_t ncx_get_full_version(xmlChar *buffer, uint32 buffsize)
Get the the Yuma version ID string and SEMVER added.
Definition: ncx.c:11259
const char * ncx_get_build_date(void)
Get the build date string encoded into this C file.
Definition: ncx.c:11298
const xmlChar * ncx_get_handle_badreply_string(ncx_bad_reply_enum badreply)
Get the string for the specified enum value.
Definition: ncx.c:17588
void ncx_free_sid_range(ncx_sid_range_t *sid_range)
Free an ncx_sid_range_t.
Definition: ncx.c:18354
void ncx_set_val_protocol_disabled(ncx_protocol_t proto, uint16 *flags)
Set the specified protocol version to be disabled in a uint16 bits val.
Definition: ncx.c:12176
void ncx_clean_sid_rangeQ(dlq_hdr_t *sid_rangeQ)
Clean a Queue of ncx_sid_range_t structs.
Definition: ncx.c:18370
dlq_hdr_t * ncx_get_rootQ(void)
Get the Root control block queue.
Definition: ncx.c:17733
const xmlChar * ncx_get_fake_notif_modname(const xmlChar *modname, const xmlChar *name)
check RESTCONF modname and convert to fake module name Used by JSON decoder.
Definition: ncx.c:18232
status_t ncx_decode_url_string(const xmlChar *urlstr, uint32 urlstrlen, xmlChar *buffer, uint32 *cnt)
Fill buffer with a plain string from a URL string.
Definition: ncx.c:12611
void ncx_set_mod_stable(boolean state)
Set the yangcli flag to indicate the module set loading modules from the server capabilities is in pr...
Definition: ncx.c:18269
const xmlChar * ncx_get_real_notif_modname(const xmlChar *modname, const xmlChar *name)
check fake notification object and get RESTCONF modname if found.
Definition: ncx.c:18199
void ncx_free_binary(ncx_binary_t *binary)
Free all the memory in a ncx_binary_t struct.
Definition: ncx.c:6875
ncx_binary_t * ncx_new_binary(void)
Malloc and fill in a new ncx_binary_t struct.
Definition: ncx.c:6812
void ncx_init_binary(ncx_binary_t *binary)
Init the memory of a ncx_binary_t struct.
Definition: ncx.c:6833
void ncx_clean_binary(ncx_binary_t *binary)
Scrub the memory of a ncx_binary_t but do not delete it.
Definition: ncx.c:6853
void ncx_clean_bit(ncx_bit_t *bit)
Scrub the memory of a ncx_bit_t but do not delete it.
Definition: ncx.c:7705
void ncx_init_bit(ncx_bit_t *bit)
Init the memory of a ncx_bit_t.
Definition: ncx.c:7683
int32 ncx_compare_bits(const ncx_bit_t *bitone, const ncx_bit_t *bittwo)
Compare 2 bit values by their schema order position.
Definition: ncx.c:7730
tk_type_t
different types of tokens parsed during 1st pass
Definition: tk.h:279
void ncx_print_errormsg_ex(tk_chain_t *tkc, ncx_module_t *mod, status_t res, const char *filename, uint32 linenum, boolean fineoln)
Print an parse error message to STDOUT (Extended)
Definition: ncx.c:8302
void ncx_mod_exp_err(tk_chain_t *tkc, ncx_module_t *mod, status_t result, const char *expstr)
Print an error for wrong token, expected a different token.
Definition: ncx.c:8451
void ncx_conf_exp_err(tk_chain_t *tkc, status_t result, const char *expstr)
Print an error for wrong token, expected a different token.
Definition: ncx.c:8423
void ncx_print_errormsg(tk_chain_t *tkc, ncx_module_t *mod, status_t res)
Print an parse error message to STDOUT.
Definition: ncx.c:8280
void ncx_free_errmsg(ncx_errmsg_t *msg)
Clean and free an ncx_errmsg_t struct.
Definition: ncx.c:16832
ncx_errmsg_t * ncx_new_errmsg(status_t res, const xmlChar *str)
Malloc and init an ncx_errmsg_t struct.
Definition: ncx.c:16804
void ncx_mod_missing_err(tk_chain_t *tkc, ncx_module_t *mod, const char *stmtstr, const char *expstr)
Print an error for wrong token, mandatory sub-statement is missing.
Definition: ncx.c:8547
void ncx_match_rpc_error(ncx_module_t *mod, const xmlChar *modname, const xmlChar *rpcname, boolean match, boolean firstmsg)
Generate an error for multiple matches.
Definition: ncx.c:4555
status_t ncx_add_namespace_to_registry(ncx_module_t *mod, boolean tempmod)
Add the namespace and prefix to the registry or retrieve it if already set.
Definition: ncx.c:4984
void ncx_set_error(ncx_error_t *tkerr, ncx_module_t *mod, uint32 linenum, uint32 linepos)
Set the fields in an ncx_error_t struct.
Definition: ncx.c:11398
boolean ncx_check_any_object_nolock_get(const xmlChar *objname)
Check if the object name will match any config=true nodes.
Definition: ncx.c:16869
status_t ncx_add_to_registry(ncx_module_t *mod)
Add all the definitions stored in an ncx_module_t to the registry.
Definition: ncx.c:5181
void ncx_clean_save_deviationsQ(dlq_hdr_t *savedevQ)
Clean a Q of deviation save structs.
Definition: ncx.c:11369
void ncx_free_save_deviations(ncx_save_deviations_t *savedev)
Free a deviation save struct.
Definition: ncx.c:11349
status_t ncx_check_yang_status(ncx_status_t mystatus, ncx_status_t depstatus)
Check the backward compatibility of the 2 YANG status fields.
Definition: ncx.c:8208
void ncx_inc_warnings(ncx_module_t *mod)
Increment the module warning count for mod.
Definition: ncx.c:11932
status_t ncx_add_to_modQ(ncx_module_t *mod, dlq_hdr_t *modQ)
Add module to the current module Q.
Definition: ncx.c:5268
status_t ncx_consume_tstring(tk_chain_t *tkc, ncx_module_t *mod, const xmlChar *name, ncx_opt_t opt)
Consume a TK_TT_TSTRING with the specified value.
Definition: ncx.c:9034
void ncx_free_module(ncx_module_t *mod)
Free a YANG module.
Definition: ncx.c:3919
ncx_save_deviations_t * ncx_new_save_deviations(ncx_module_t *devmod, boolean annotation)
Create a deviation save structure.
Definition: ncx.c:11318
status_t ncx_parse_name(const xmlChar *str, uint32 *len)
Check if the next N chars represent a valid NcxName.
Definition: ncx.c:8938
status_t ncx_setup_mounted_mod(ncx_module_t *mod)
Setup a module for yangcli in parsemode in SM mode.
Definition: ncx.c:5356
boolean ncx_need_modchecks(const xmlChar *modname)
Check if xpath_backptr and obj commit tests needed.
Definition: ncx.c:15681
status_t ncx_consume_name(tk_chain_t *tkc, ncx_module_t *mod, const xmlChar *name, xmlChar **namebuff, ncx_opt_t opt, tk_type_t ctyp)
Consume a TK_TSTRING that matches the 'name', then retrieve the next TK_TSTRING token into the namebu...
Definition: ncx.c:9092
status_t ncx_consume_token(tk_chain_t *tkc, ncx_module_t *mod, tk_type_t ttyp)
Consume the next token which should be a 1 or 2 char token without any value.
Definition: ncx.c:9192
void ncx_free_node(ncx_node_t nodetyp, void *node)
Delete a node based on its type.
Definition: ncx.c:8581
const xmlChar * ncx_get_name_segment(const xmlChar *str, xmlChar *buff, uint32 buffsize)
Get the name string between the dots.
Definition: ncx.c:8060
ncx_tclass_t ncx_get_tclass(ncx_btype_t btyp)
Get the token class.
Definition: ncx.c:8731
ncx_module_t * ncx_new_module(void)
Malloc and initialize the fields in a ncx_module_t.
Definition: ncx.c:3646
status_t ncx_init_user_types(void)
Initialize the user types after ietf-inet-types module loaded.
Definition: ncx.c:16852
status_t ncx_add_to_root_modQ(ncx_module_t *mod)
Add module to the current module Q.
Definition: ncx.c:5297
boolean ncx_errinfo_set(const ncx_errinfo_t *errinfo)
Check if error-app-tag or error-message set.
Definition: ncx.c:9370
void ncx_clean_errinfo(ncx_errinfo_t *err)
Scrub the memory in a ncx_errinfo_t by freeing all the sub-fields.
Definition: ncx.c:9312
ncx_errinfo_t * ncx_new_errinfo(void)
Malloc and init a new ncx_errinfo_t.
Definition: ncx.c:9271
status_t ncx_copy_errinfo(const ncx_errinfo_t *src, ncx_errinfo_t *dest)
Copy the fields from one errinfo to a blank errinfo.
Definition: ncx.c:9395
void ncx_init_errinfo(ncx_errinfo_t *err)
Init the fields in an ncx_errinfo_t struct.
Definition: ncx.c:9291
void ncx_free_errinfo(ncx_errinfo_t *err)
Scrub the memory in a ncx_errinfo_t by freeing all the sub-fields, then free the errinfo struct.
Definition: ncx.c:9347
void ncx_free_filptr(ncx_filptr_t *filptr)
Free a new ncx_filptr_t struct or add to the cache if room.
Definition: ncx.c:7469
ncx_filptr_t * ncx_new_filptr(void)
Get a new ncx_filptr_t struct.
Definition: ncx.c:7432
ncx_revhist_t * ncx_new_revhist(void)
Create a revision history entry.
Definition: ncx.c:7500
ncx_revhist_t * ncx_find_revhist(const ncx_module_t *mod, const xmlChar *ver)
Search the revhistQ for a specified revision.
Definition: ncx.c:7549
void ncx_free_revhist(ncx_revhist_t *revhist)
Free a revision history entry.
Definition: ncx.c:7520
void ncx_clean_typnameQ(dlq_hdr_t *que)
Delete all the Q entries, of typname mapping structs.
Definition: ncx.c:7865
void ncx_free_typname(ncx_typname_t *typnam)
Free a typname struct.
Definition: ncx.c:7780
const xmlChar * ncx_find_typname(const typ_template_t *typ, const dlq_hdr_t *que)
Find a typname struct in the specified Q for a typ pointer.
Definition: ncx.c:7803
ncx_typname_t * ncx_new_typname(void)
Malloc and init a typname struct.
Definition: ncx.c:7760
const typ_template_t * ncx_find_typname_type(const dlq_hdr_t *que, const xmlChar *typname)
Find a typ_template_t pointer in a typename mapping, in the specified Q.
Definition: ncx.c:7835
void ncx_save_deviation_module(ncx_module_t *mod)
Save the deviations for the YANG module.
Definition: ncx.c:14781
boolean ncx_ok_skip_deviation_module(const xmlChar *modname, dlq_hdr_t *save_deviationsQ)
Check if it is OK to skip this YANG module for deviations.
Definition: ncx.c:14805
ncx_save_deviations_t * ncx_find_save_deviations(const xmlChar *deviname, dlq_hdr_t *deviationQ)
Find the specified deviname in the deviationQ.
Definition: ncx.c:14744
void ncx_init_enum(ncx_enum_t *enu)
Init the memory of a ncx_enum_t.
Definition: ncx.c:7581
status_t ncx_set_enum(const xmlChar *enum_name, const int32 enum_val, ncx_enum_t *retenu)
Parse an enumerated integer string into an ncx_enum_t without matching it against any typdef.
Definition: ncx.c:7654
void ncx_clean_enum(ncx_enum_t *enu)
Scrub the memory of a ncx_enum_t but do not delete it.
Definition: ncx.c:7603
int32 ncx_compare_enums(const ncx_enum_t *enu1, const ncx_enum_t *enu2)
Compare 2 enum values.
Definition: ncx.c:7628
boolean ncx_valid_name(const xmlChar *str, uint32 len)
Check if an xmlChar string is a valid YANG identifier value.
Definition: ncx.c:8826
boolean ncx_valid_name2(const xmlChar *str)
Check if an xmlChar string is a valid NCX name.
Definition: ncx.c:8871
boolean ncx_valid_name_ch(uint32 ch)
Check if the character is a valid YANG identifier chara.
Definition: ncx.c:8779
boolean ncx_valid_fname_ch(uint32 ch)
Check if an xmlChar is a valid NCX name string first char.
Definition: ncx.c:8803
ncx_identity_base_t * ncx_next_identity_base(ncx_identity_base_t *idbase)
Get the next base record for an identity.
Definition: ncx.c:6980
void ncx_free_identity_base(ncx_identity_base_t *identity_base)
Free a malloced ncx_identity_base_t struct.
Definition: ncx.c:6942
void ncx_for_all_identities(ncx_module_t *mod, ncx_identity_cbfn_t cbfn, void *cookie)
Iterate all the YANG identities in the module.
Definition: ncx.c:7166
ncx_identity_base_t * ncx_new_identity_base(void)
Get a new ncx_identity_base_t struct.
Definition: ncx.c:6922
void ncx_find_all_identities(ncx_identity_t *base, ncx_identity_cbfn_t cbfn, void *cookie)
Invoke callback for all the found identities.
Definition: ncx.c:13518
xmlns_id_t ncx_get_identity_nsid(const ncx_identity_t *identity)
Get the namespace ID for an identity.
Definition: ncx.c:7392
void ncx_free_identity(ncx_identity_t *identity)
Free a malloced ncx_identity_t struct.
Definition: ncx.c:7017
ncx_identity_t * ncx_new_identity(void)
Get a new ncx_identity_t struct.
Definition: ncx.c:6896
ncx_identity_base_t * ncx_first_identity_base(ncx_identity_t *identity)
Get the first base record for an identity.
Definition: ncx.c:6961
ncx_identity_t * ncx_find_identity_que(dlq_hdr_t *identityQ, const xmlChar *name)
Find a ncx_identity_t struct in the specified Q.
Definition: ncx.c:7362
ncx_identity_t * ncx_find_identity(ncx_module_t *mod, const xmlChar *name, boolean useall)
Find a ncx_identity_t struct in the module and perhaps any of its submodules.
Definition: ncx.c:7072
boolean ncx_get_identity_conditional(const ncx_identity_t *identity)
Check if the identity is conditional on if-feature.
Definition: ncx.c:7411
ncx_import_t * ncx_new_import(void)
Malloc and initialize the fields in a ncx_import_t.
Definition: ncx.c:6407
ncx_import_t * ncx_find_import_que(const dlq_hdr_t *importQ, const xmlChar *module)
Search the specified importQ for a specified module name.
Definition: ncx.c:6496
void * ncx_locate_modqual_import(yang_pcb_t *pcb, ncx_import_t *imp, const xmlChar *defname, ncx_node_t *deftyp)
Search the specific module for the specified definition name.
Definition: ncx.c:6697
ncx_import_t * ncx_find_pre_import(const ncx_module_t *mod, const xmlChar *prefix)
Search the importQ for a specified prefix value.
Definition: ncx.c:6559
void ncx_free_import(ncx_import_t *import)
Free an ncx_import_t.
Definition: ncx.c:6431
ncx_import_t * ncx_find_import_test(const ncx_module_t *mod, const xmlChar *module)
Search the importQ for a specified module name.
Definition: ncx.c:6529
boolean ncx_import_match_mod(const ncx_import_t *imp, const xmlChar *module, const xmlChar *revision)
Check if the import matches the specified module.
Definition: ncx.c:6643
ncx_import_t * ncx_find_pre_import_que(const dlq_hdr_t *importQ, const xmlChar *prefix)
Search the specified importQ for a specified prefix value.
Definition: ncx.c:6581
ncx_import_t * ncx_find_import(const ncx_module_t *mod, const xmlChar *module)
Search the importQ for a specified module name.
Definition: ncx.c:6474
ncx_import_t * ncx_find_pre_import_test(const ncx_module_t *mod, const xmlChar *prefix)
Search the importQ for a specified prefix value.
Definition: ncx.c:6613
ncx_include_t * ncx_new_include(void)
Malloc and initialize the fields in a ncx_include_t.
Definition: ncx.c:6722
void ncx_free_include(ncx_include_t *inc)
Free a ncx_include_t.
Definition: ncx.c:6746
ncx_include_t * ncx_find_include(const ncx_module_t *mod, const xmlChar *submodule)
Search the includeQ for a specified submodule name.
Definition: ncx.c:6783
void ncx_clear_unload_callback(ncx_unload_cbfn_t cbfn)
Clear the callback function for an unload-module event.
Definition: ncx.c:9900
status_t ncx_set_load_callback(ncx_load_cbfn_t cbfn)
Set the callback function for a load-module event.
Definition: ncx.c:9793
void ncx_register_get_owner_fn(ncx_get_owner_fn_t cbfn)
Register a callback to get the owner name.
Definition: ncx.c:14597
void ncx_invoke_yang_obj_callbacks(ncx_module_t *mod, obj_template_t *obj)
Invoke all the callback functions for a parse-object event.
Definition: ncx.c:9999
status_t ncx_set_unload_callback(ncx_unload_cbfn_t cbfn)
Set the callback function for an unload-module event.
Definition: ncx.c:9862
status_t ncx_set_yang_obj_callback(ncx_yang_obj_cbfn_t cbfn)
Set the callback function for a YANG object parse event.
Definition: ncx.c:9931
void ncx_clear_load_callback(ncx_load_cbfn_t cbfn)
Clear the callback function for a load-module event.
Definition: ncx.c:9831
void ncx_clear_yang_obj_callback(ncx_yang_obj_cbfn_t cbfn)
Clear the callback function for a parse-object event.
Definition: ncx.c:9970
const xmlChar * ncx_get_owner_name(ncx_owner_id_t owner_id)
Get the registered YANG library owner namefor owner_id.
Definition: ncx.c:14612
dlq_hdr_t * ncx_get_session_modQ(void)
Get the current session modQ.
Definition: ncx.c:9753
void ncx_set_cur_modQ(dlq_hdr_t *que)
Set the current module Q to an alternate (for yangdiff)
Definition: ncx.c:9692
void ncx_clear_temp_modQ(void)
Clear the temp_modQ for yangcli session-specific module list.
Definition: ncx.c:11455
void ncx_clear_session_modQ(void)
Clear the current session modQ.
Definition: ncx.c:9773
dlq_hdr_t * ncx_get_temp_modQ(void)
Get the temp_modQ for yangcli session-specific module list.
Definition: ncx.c:11441
void ncx_set_temp_modQ(dlq_hdr_t *modQ)
Set the temp_modQ for yangcli session-specific module list.
Definition: ncx.c:11425
void ncx_reset_modQ(void)
Set the current module Q to the original ncx_modQ.
Definition: ncx.c:9711
void ncx_set_session_modQ(dlq_hdr_t *que)
Get the session module Q.
Definition: ncx.c:9734
status_t ncx_turn_up_warning(status_t res)
Add a warning elevation entry.
Definition: ncx.c:10848
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.
Definition: ncx.c:10683
void ncx_set_warn_error(boolean val)
Set the warn_error flag.
Definition: ncx.c:10865
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_r...
Definition: ncx.c:12534
void ncx_set_warn_idlen(uint32 warnlen)
Set the warning length for identifiers.
Definition: ncx.c:10611
uint32 ncx_get_warn_idlen(void)
Get the warning length for identifiers.
Definition: ncx.c:10627
void ncx_set_empty_npcon_presence(boolean val)
Set the empty_npcon_presence value.
Definition: ncx.c:15841
void ncx_set_module_setid(uint32 new_setid)
Update YANG-LIBRARY module set ID.
Definition: ncx.c:15710
boolean ncx_get_empty_npcon_presence(void)
Get the empty_npcon_presence value.
Definition: ncx.c:15823
void ncx_set_warn_linelen(uint32 warnlen)
Set the warning length for YANG file lines.
Definition: ncx.c:10644
void ncx_set_warn_off_yang(boolean val)
Set the warn_off_yang flag.
Definition: ncx.c:10882
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.
Definition: ncx.c:10726
status_t ncx_turn_off_warning(status_t res)
Add a warning suppression entry.
Definition: ncx.c:10785
boolean ncx_get_empty_npcon_presence_ro(void)
Get the empty_npcon_presence value READ-ONLY check.
Definition: ncx.c:15860
boolean ncx_get_warn_off_yang(void)
Get the warn_off_yang flag.
Definition: ncx.c:10899
boolean ncx_get_top_mandatory_allowed(void)
Check if top-level mandatory objects are allowed or not.
Definition: ncx.c:12549
uint32 ncx_get_module_setid(void)
GET YANG-LIBRARY module set ID.
Definition: ncx.c:15728
uint32 ncx_get_warn_linelen(void)
Get the warning length for YANG file lines.
Definition: ncx.c:10661
status_t ncx_turn_on_warning(status_t res)
Remove a warning suppression entry if it exists.
Definition: ncx.c:10804
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.
Definition: ncx.c:15751
void ncx_delete_all_obsolete_objects(void)
Go through all the modules and delete the obsolete nodes.
Definition: ncx.c:12334
boolean ncx_collapse_submodules_ok(void)
Check if it is OK to collapse submodule definitions into the main module.
Definition: ncx.c:13065
void ncx_set_empty_npcon_presence_ro(boolean val)
Set the empty_npcon_presence value READ-ONLY check.
Definition: ncx.c:15879
boolean ncx_warning_elevated(status_t res)
Check if a specific status_t code is elevated.
Definition: ncx.c:10965
boolean ncx_warning_enabled(status_t res)
Check if a specific status_t code is enabled.
Definition: ncx.c:10922
ncx_module_t * ncx_find_deviation_module(const xmlChar *modname)
Find a deviation module ncx_module_t in the deviation_moduleQ;.
Definition: ncx.c:15794
obj_template_t * ncx_next_data_node(obj_template_t *curnode)
Check if an obj_template_t in in any module that matches a data node either config or all.
Definition: ncx.c:15972
ncx_module_t * ncx_get_first_module(void)
Get the first module in the ncx_modQ.
Definition: ncx.c:5442
obj_template_t * ncx_match_any_object_ex(const xmlChar *modname, const xmlChar *objname, boolean dataonly, ncx_name_match_t name_match, boolean alt_names, status_t *retres)
Match any object in any YANG module with double extra search options.
Definition: ncx.c:4754
obj_template_t * ncx_match_any_object(const xmlChar *objname, ncx_name_match_t name_match, boolean alt_names, status_t *retres)
Match any object in any YANG module with extra search options.
Definition: ncx.c:4665
ncx_module_t * ncx_find_module_que(dlq_hdr_t *modQ, const xmlChar *modname, const xmlChar *revision)
Find a ncx_module_t in the specified Q of ncx_module_t.
Definition: ncx.c:3798
obj_template_t * ncx_find_first_rpc(const xmlChar *rpcname)
Find the specified RPC Method in any module.
Definition: ncx.c:4374
ncx_module_t * ncx_get_next_module(const ncx_module_t *mod)
Get the next module in the ncx_modQ.
Definition: ncx.c:5464
ncx_module_t * ncx_find_next_importer(const xmlChar *module, ncx_module_t *curmod)
Search all modules importQs for a specified module name.
Definition: ncx.c:13811
ncx_module_t * ncx_find_module_que_nsid(dlq_hdr_t *modQ, xmlns_id_t nsid)
Find a ncx_module_t in the specified Q by namespace ID.
Definition: ncx.c:3883
ncx_module_t * ncx_get_next_module_all(const ncx_module_t *mod)
Get the first module entry in the ncx_modQ.
Definition: ncx.c:5524
obj_template_t * ncx_find_any_object_que(dlq_hdr_t *modQ, const xmlChar *objname)
Find any top-level YANG object in a module in the modQ.
Definition: ncx.c:4900
ncx_module_t * ncx_find_module_by_prefix(const xmlChar *prefix)
Find an ncx_module_t in the ncx_sesmodQ by prefix.
Definition: ncx.c:3765
ncx_module_t * ncx_get_first_session_module(void)
Get the first module in the ncx_sesmodQ.
Definition: ncx.c:5545
ncx_module_t * ncx_first_deviation_module(void)
Get the first deviation module.
Definition: ncx.c:16268
obj_template_t * ncx_match_any_rpc(const xmlChar *module, const xmlChar *rpcname, uint32 *retcount)
Match the specified module name in any module.
Definition: ncx.c:4464
ncx_module_t * ncx_next_deviation_module(ncx_module_t *curmod)
Get the next deviation module after curmod.
Definition: ncx.c:16287
ncx_module_t * ncx_find_module_que_by_prefix(dlq_hdr_t *modQ, const xmlChar *prefix)
Find a ncx_module_t in the specified Q by prefix value.
Definition: ncx.c:3847
ncx_module_t * ncx_find_first_importer(const xmlChar *module)
Search all modules importQs for a specified module name.
Definition: ncx.c:13780
obj_template_t * ncx_find_any_object(const xmlChar *objname)
Find any top-level object in any YANG module.
Definition: ncx.c:4603
ncx_module_t * ncx_get_next_session_module(const ncx_module_t *mod)
Get the next module in the ncx_sesmodQ.
Definition: ncx.c:5565
obj_template_t * ncx_first_data_node(boolean cfgonly)
Check if an obj_template_t in in any module that matches a data node either config or all.
Definition: ncx.c:15914
ncx_module_t * ncx_get_prev_module(const ncx_module_t *mod)
Get the previous module.
Definition: ncx.c:5492
ncx_module_t * ncx_find_module_ex(const xmlChar *modname, const xmlChar *revision)
Find an ncx_module_t in the ncx_sesmodQ.
Definition: ncx.c:3734
ncx_module_t * ncx_find_module(const xmlChar *modname, const xmlChar *revision)
Find a ncx_module_t in the ncx_sesmodQ.
Definition: ncx.c:3700
uint32 ncx_mod_revision_count_que(xml_msg_hdr_t *msg, dlq_hdr_t *modQ, const xmlChar *modname)
Find all the ncx_module_t structs in the specified queue that have the same module name.
Definition: ncx.c:11563
boolean ncx_any_mod_errors(void)
Check if any of the loaded modules are loaded with non-fatal errors.
Definition: ncx.c:3939
uint32 ncx_mod_revision_count(xml_msg_hdr_t *msg, const xmlChar *modname)
Find all the ncx_module_t structs in the ncx_modQ that have the same module name.
Definition: ncx.c:11527
void dump_modQ(dlq_hdr_t *modQ)
dump module Q contents [name, revision] for debugging
Definition: ncx.c:12696
boolean ncx_save_descr(void)
Get the value of the save description strings variable.
Definition: ncx.c:8264
uint32 ncx_dev_revision_count_que(xml_msg_hdr_t *msg, dlq_hdr_t *deviationQ, const xmlChar *modname)
Find all the ncx_save_deviations_t structs in the specified queue that have the same module name.
Definition: ncx.c:11624
obj_template_t * ncx_get_last_object(ncx_module_t *mod, boolean augment_ok)
Find the last data node.
Definition: ncx.c:5826
obj_template_t * ncx_match_rpc(ncx_module_t *mod, const xmlChar *rpcname, uint32 *retcount)
Check if a rpc_template_t in the mod->rpcQ.
Definition: ncx.c:4414
obj_template_t * ncx_get_next_object_ex(ncx_module_t *mod, obj_template_t *curobj, boolean augment_ok)
Get the next object in the specified module.
Definition: ncx.c:5918
obj_template_t * ncx_find_object(ncx_module_t *mod, const xmlChar *objname)
Find a top level module object.
Definition: ncx.c:4934
obj_template_t * ncx_find_next_data_object(ncx_module_t *mod, obj_template_t *obj)
Check the next obj_template_t in in any module that matches the object name string.
Definition: ncx.c:4851
grp_template_t * ncx_find_grouping(ncx_module_t *mod, const xmlChar *grpname, boolean useall)
Find the YANG grouping.
Definition: ncx.c:4214
obj_template_t * ncx_get_first_data_object(ncx_module_t *mod)
Get the first datastore object in the module.
Definition: ncx.c:6092
obj_template_t * ncx_match_any_rpc_mod(ncx_module_t *mod, const xmlChar *rpcname, uint32 *retcount)
Check if a rpc_template_t is in the specified module.
Definition: ncx.c:4522
obj_template_t * ncx_find_rpc(const ncx_module_t *mod, const xmlChar *rpcname)
Check if a rpc_template_t in the mod->rpcQ.
Definition: ncx.c:4342
obj_template_t * ncx_get_prev_object(ncx_module_t *mod, obj_template_t *curobj, boolean augment_ok)
Find the previous object node.
Definition: ncx.c:6007
obj_template_t * ncx_get_next_data_object_same(ncx_module_t *mod, obj_template_t *curobj)
Get the next database object in the specified module.
Definition: ncx.c:6328
obj_template_t * ncx_get_first_object_ex(ncx_module_t *mod, boolean augment_ok)
Get the first object in the datadefQs for the specified module.
Definition: ncx.c:5748
typ_template_t * ncx_find_type(ncx_module_t *mod, const xmlChar *typname, boolean useall)
Check if a typ_template_t in the mod->typeQ.
Definition: ncx.c:4141
typ_template_t * ncx_find_type_que(const dlq_hdr_t *typeQ, const xmlChar *typname)
ncx_find_type_que
Definition: ncx.c:4181
typ_template_t * ncx_find_annotation(ncx_module_t *mod, const xmlChar *name, boolean useall)
Find an annotation.
Definition: ncx.c:4159
obj_template_t * ncx_get_next_data_object(ncx_module_t *mod, obj_template_t *curobj)
Get the next database object in the specified module.
Definition: ncx.c:6164
obj_template_t * ncx_get_next_object(ncx_module_t *mod, obj_template_t *curobj)
Get the next object in the specified module.
Definition: ncx.c:5900
obj_template_t * ncx_find_object_nsid(xmlns_id_t nsid, const xmlChar *objname)
Find a top level module object by module NSID.
Definition: ncx.c:4954
grp_template_t * ncx_find_grouping_que(const dlq_hdr_t *groupingQ, const xmlChar *grpname)
Check if a grp_template_t in the specified Q.
Definition: ncx.c:4311
obj_template_t * ncx_get_first_object(ncx_module_t *mod)
Get the first object in the datadefQs for the specified module.
Definition: ncx.c:5730
obj_template_t * ncx_get_first_data_object_pick(ncx_module_t *mod, boolean config)
Get the first database object in the datadefQs for the specified module.
Definition: ncx.c:6246
const xmlChar * ncx_get_modversion(const ncx_module_t *mod)
Get the [sub]module version.
Definition: ncx.c:5630
const xmlChar * ncx_get_mod_source(const ncx_module_t *mod)
Get the module file source string for the specified module.
Definition: ncx.c:10290
ncx_module_t * ncx_get_mainmod(ncx_module_t *mod)
Get the main module.
Definition: ncx.c:5703
const xmlChar * ncx_get_mod_xmlprefix(const ncx_module_t *mod)
Get the module XML prefix for the specified module.
Definition: ncx.c:10262
boolean ncx_mod_unloadable(ncx_module_t *mod)
Check if this module can be unloaded.
Definition: ncx.c:14045
ncx_module_t * ncx_first_submodule(ncx_module_t *mod)
Get the first submodule in the specified main module.
Definition: ncx.c:14168
const dlq_hdr_t * ncx_get_const_allincQ(const ncx_module_t *mod)
Find the correct Q of yang_node_t for all include files that have the same 'belongs-to' value (const ...
Definition: ncx.c:11702
void ncx_clr_enable_chk(ncx_module_t *mod)
Clear the enable check test done flag in all objects in the specified module.
Definition: ncx.c:16551
const xmlChar * ncx_get_mod_prefix(const ncx_module_t *mod)
Get the module prefix for the specified module.
Definition: ncx.c:10237
void ncx_set_mod_unloadable(ncx_module_t *mod)
Set this module so it can be unloaded.
Definition: ncx.c:14067
boolean ncx_modname_is_ocpattern(const xmlChar *modname)
Check if the module name is an openconfig file.
Definition: ncx.c:16144
const xmlChar * ncx_get_mod_ocversion(const ncx_module_t *mod)
Get the module openconfig-version string for the specified module.
Definition: ncx.c:10338
const xmlChar * ncx_get_modnamespace(const ncx_module_t *mod)
Get the module namespace URI.
Definition: ncx.c:5650
boolean ncx_get_ocpattern_mode(const ncx_module_t *mod)
Get the openconfig pattern mode.
Definition: ncx.c:16122
ncx_module_t * ncx_get_parent_mod(ncx_module_t *mod)
Find the correct module by checking mod->parent nodes.
Definition: ncx.c:11730
boolean ncx_is_yangmap_type(ncx_module_t *mod, boolean is_src)
Check the yangmap type flags.
Definition: ncx.c:16773
status_t ncx_check_yang_identity(ncx_module_t *impmod, const xmlChar *idstr)
Check if an identity string is available in the module.
Definition: ncx.c:16011
status_t ncx_set_mod_ietfversion(ncx_module_t *mod, const xmlChar *version)
Set the module IETF Semver string for the specified module.
Definition: ncx.c:10418
xmlns_id_t ncx_get_mod_nsid(const ncx_module_t *mod)
Get the main module namespace ID.
Definition: ncx.c:5606
const xmlChar * ncx_get_mod_revision(const ncx_module_t *mod)
Get the module revision string for the specified module.
Definition: ncx.c:10315
boolean ncx_mod_has_rpcs(ncx_module_t *mod)
Check if the module has any RPC operation definitions.
Definition: ncx.c:12726
void ncx_set_ocpattern_mode(ncx_module_t *mod, boolean mode)
Set the openconfig pattern mode.
Definition: ncx.c:16070
boolean ncx_mod_has_submodules(const ncx_module_t *mod)
Check if this is a main module with submodules.
Definition: ncx.c:17514
void ncx_set_module_supported(ncx_module_t *mod, boolean supported)
Set the module supported field.
Definition: ncx.c:14487
const xmlChar * ncx_get_modsource(const ncx_module_t *mod)
Get the module filespec source string.
Definition: ncx.c:5683
boolean ncx_skip_child_node_warn(const xmlChar *modname)
Internal compiler check to suppress warnings.
Definition: ncx.c:16528
void ncx_force_ocpattern_mode(ncx_module_t *mod)
Force the openconfig pattern mode to TRUE.
Definition: ncx.c:16097
const xmlChar * ncx_get_mod_ietfversion(const ncx_module_t *mod)
Get the module IETF Semver string for the specified module.
Definition: ncx.c:10397
boolean ncx_mod_is_hidden(const ncx_module_t *mod)
Check if the module is forced no advertise (e.g.
Definition: ncx.c:15192
ncx_yang_version_t ncx_get_yang_version(const ncx_module_t *mod)
Get the yang-version used in the module.
Definition: ncx.c:15018
ncx_module_t * ncx_next_submodule(ncx_module_t *mod, ncx_module_t *submod)
Get the next submodule in the specified main module.
Definition: ncx.c:14202
status_t ncx_set_mod_ocversion(ncx_module_t *mod, const xmlChar *ocversion)
Set the module openconfig-version string for the specified module.
Definition: ncx.c:10361
boolean ncx_is_duplicate(ncx_module_t *mod, const xmlChar *defname)
Check if a module definition name is a duplicate.
Definition: ncx.c:5416
status_t ncx_compare_semvers(const xmlChar *version1, const xmlChar *version2, int32 *ret)
Compare two IETF or OC Semver values.
Definition: ncx.c:10463
dlq_hdr_t * ncx_get_allincQ(ncx_module_t *mod)
Find the correct Q of yang_node_t for all include files that have the same 'belongs-to' value.
Definition: ncx.c:11674
boolean ncx_mod_has_augment_data_nodes(ncx_module_t *mod, boolean check_config, boolean check_operational)
Check if the module has any augment datastore definitions.
Definition: ncx.c:12877
boolean ncx_mod_has_data_nodes(ncx_module_t *mod, boolean check_config, boolean check_operational)
Check if the module has any datastore definitions.
Definition: ncx.c:12773
boolean ncx_any_dependency_errors(const ncx_module_t *mod)
Check if any of the imports that this module relies on were loadeds are loaded with non-fatal errors.
Definition: ncx.c:3966
const xmlChar * ncx_get_modname(const ncx_module_t *mod)
Get the main module name.
Definition: ncx.c:5586
void ncx_number_all_objects(ncx_module_t *mod)
Number all objects for internal ordering comparisons.
Definition: ncx.c:15113
void ncx_set_yangmap_type(ncx_module_t *mod, boolean is_src)
Set the yangmap type flags.
Definition: ncx.c:16744
void ncx_unload_and_free_module(ncx_module_t *mod)
Clear out the xmlns, def_ref, and modQ entries for a module and then delete the module.
Definition: ncx.c:13913
void ncx_clear_mod_xpath_backptrs(ncx_module_t *mod)
Clear Xpath back pointers for the data-db objects in the database for 1 module.
Definition: ncx.c:13846
void ncx_collapse_submod_defs(ncx_module_t *mod)
Collapse submodule definitions into the main module.
Definition: ncx.c:13088
void ncx_soft_unload_and_free_module(ncx_module_t *mod)
Clear out the modQ entries for a module and then delete the module.
Definition: ncx.c:13984
void ncx_remove_augment_data_nodes(ncx_module_t *mod)
Check if YANG objects related to this augment need to be removed.
Definition: ncx.c:12991
status_t ncx_set_obj_xpath_backptrs(ncx_module_t *mod)
Add Xpath back pointers to the data-db objects in the database for 1 module.
Definition: ncx.c:13186
void ncx_delete_mod_obsolete_objects(ncx_module_t *mod)
Delete all obsolete objects in mod.
Definition: ncx.c:12357
YANG Grouping Statement Handler.
NCX System Logging Manager.
Contains NCX constants.
YANG module data structures Many internal representations of YANG module constructs.
Data Object Support.
NETCONF protocol remote procedure call common definitions.
One YANG 'grouping' definition – sibling set template.
Definition: grp.h:87
used with various structs to cache back-ptrs the 'node' pointer may or may not be malloced!...
Definition: ncxtypes.h:1584
NCX base64 string node for YANG 'binary' built-in type.
Definition: ncxtypes.h:901
one NCX_BT_BITS bit value
Definition: ncxtypes.h:854
one NCX_BT_ENUM enumeration value (user may enter 1 of 3 forms)
Definition: ncxtypes.h:846
YANG error info statement struct used to override default error handling in the server.
Definition: ncxtypes.h:1420
error message replacement record
Definition: ncxtypes.h:1678
struct to remember error info tkc->cur_err will be checked before tkc->cur for error information
Definition: ncxtypes.h:912
struct for holding r/o pointer to generic internal node for filtering purposes
Definition: ncxtypes.h:1100
YANG identity base.
Definition: ncxtypes.h:1134
YANG identity entry.
Definition: ncxtypes.h:1143
One 'import' clause in YANG.
Definition: ncxtypes.h:1352
One 'include' clause, YANG only.
Definition: ncxtypes.h:1382
server module info cache record for def_reg_add_mod
Definition: ncxtypes.h:1669
representation of one module or submodule during and after parsing
Definition: ncxtypes.h:1180
YANG revision entry.
Definition: ncxtypes.h:950
used with obj_deviation_t to defer object lookups
Definition: ncxtypes.h:1559
YANG SID assignment range struct.
Definition: ncxtypes.h:781
Schema Mount Root Control Block used in the object template.
Definition: ncxtypes.h:1947
keep track of the typenames used for local typedefs only used by ncxdump to generate XSDs OBSOLETE: D...
Definition: ncxtypes.h:1442
One YANG data-def-stmt.
Definition: obj.h:1284
Session Control Block.
Definition: ses.h:759
token parsing chain (main parser control block)
Definition: tk.h:415
One YANG 'typedef' definition – top-level type template Also used for a YANG Metadata Annotation.
Definition: typ.h:501
Common Encoding Message Header No longer XML specific!! Used by JSON and CBOR parsing as well!...
Definition: xml_msg.h:476
YANG parser control block.
Definition: yang.h:204
NCX Syntax Token Handler.
Parameter Type Handler.
Value Node Basic Support.
XML namespace support.
YANG Module parser utilities.