yumapro  20.10-12
YumaPro SDK
libncx.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
3  * Copyright (c) 2012 - 2021, 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_libncx
13 #define _H_libncx
14 
15 /* FILE: libncx.h
16 *********************************************************************
17 * *
18 * P U R P O S E *
19 * *
20 *********************************************************************/
21 
27 /*
28  *** THIS FILE IS OBSOLETE AND OUT OF DATE ***
29  *** DO NOT USE ***
30 
31  This is a wrapper for all NCX Library functions.
32  Include individual H files instead to save compile time.
33 
34 
35 
36  NCX Module Library Utility Functions
37 
38 
39  Container of Definitions
40  +-----------------+
41  | ncx_module_t |
42  | ncxtypes.h |
43  +-----------------+
44 
45  Template/Schema
46  +-----------------+
47  | obj_template_t |
48  | obj.h |
49  +-----------------+
50  ^ |
51  | | Value Instances
52  | | +-----------------+
53  | +---->| val_value_t |
54  | | val.h |
55  | +-----------------+
56  |
57  | Data Types
58  | +--------------------+
59  +---| typ_template_t |
60  | typ.h |
61  +--------------------+
62 
63 
64 *********************************************************************
65 * *
66 * C H A N G E H I S T O R Y *
67 * *
68 *********************************************************************
69 
70 date init comment
71 ----------------------------------------------------------------------
72 29-oct-05 abb Begun
73 20-jul-08 abb Start YANG rewrite; remove PSD and PS
74 23-aug-09 abb Update diagram in header
75 29-may-10 abb Make libncx wrapper for all H files
76  in libncx.so
77 18-may-13 abb updated.
78 */
79 
80 #ifdef __cplusplus
81 extern "C" {
82 #endif
83 
84 #include <xmlstring.h>
85 
86 #ifndef _H_procdefs
87 #include "procdefs.h"
88 #endif
89 
90 #ifndef _H_b64
91 #include "b64.h"
92 #endif
93 
94 #ifndef _H_blob
95 #include "blob.h"
96 #endif
97 
98 #ifndef _H_bobhash
99 #include "bobhash.h"
100 #endif
101 
102 #ifndef _H_cap
103 #include "cap.h"
104 #endif
105 
106 #ifndef _H_cfg
107 #include "cfg.h"
108 #endif
109 
110 #ifndef _H_cli
111 #include "cli.h"
112 #endif
113 
114 #ifndef _H_conf
115 #include "conf.h"
116 #endif
117 
118 #ifndef _H_def_reg
119 #include "def_reg.h"
120 #endif
121 
122 #ifndef _H_dlq
123 #include "dlq.h"
124 #endif
125 
126 #ifndef _H_ext
127 #include "ext.h"
128 #endif
129 
130 #ifndef _H_getcb
131 #include "getcb.h"
132 #endif
133 
134 #ifndef _H_grp
135 #include "grp.h"
136 #endif
137 
138 #ifndef _H_heapchk
139 #include "heapchk.h"
140 #endif
141 
142 #ifndef _H_help
143 #include "help.h"
144 #endif
145 
146 #ifndef _H_json_wr
147 #include "json_wr.h"
148 #endif
149 
150 #ifndef _H_log
151 #include "log.h"
152 #endif
153 
154 #ifndef _H_log_syslog
155 #include "log_syslog.h"
156 #endif
157 
158 #ifndef _H_log_util
159 #include "log_util.h"
160 #endif
161 
162 #ifndef _H_log_vendor_extern
163 #include "log_vendor_extern.h"
164 #endif
165 
166 #ifndef _H_log_vendor
167 #include "log_vendor.h"
168 #endif
169 
170 #ifndef _H_ncx_appinfo
171 #include "ncx_appinfo.h"
172 #endif
173 
174 #ifndef _H_ncxconst
175 #include "ncxconst.h"
176 #endif
177 
178 #ifndef _H_ncx_feature
179 #include "ncx_feature.h"
180 #endif
181 
182 #ifndef _H_ncx
183 #include "ncx.h"
184 #endif
185 
186 #ifndef _H_ncx_list
187 #include "ncx_list.h"
188 #endif
189 
190 #ifndef _H_ncxmod
191 #include "ncxmod.h"
192 #endif
193 
194 #ifndef _H_ncx_num
195 #include "ncx_num.h"
196 #endif
197 
198 #ifndef _H_ncx_str
199 #include "ncx_str.h"
200 #endif
201 
202 #ifndef _H_ncxtypes
203 #include "ncxtypes.h"
204 #endif
205 
206 #ifndef _H_obj
207 #include "obj.h"
208 #endif
209 
210 #ifndef _H_obj_help
211 #include "obj_help.h"
212 #endif
213 
214 #ifndef _H_op
215 #include "op.h"
216 #endif
217 
218 #ifndef _H_plock_cb
219 #include "plock_cb.h"
220 #endif
221 
222 #ifndef _H_plock
223 #include "plock.h"
224 #endif
225 
226 #ifndef _H_rpc_err
227 #include "rpc_err.h"
228 #endif
229 
230 #ifndef _H_rpc
231 #include "rpc.h"
232 #endif
233 
234 #ifndef _H_runstack
235 #include "runstack.h"
236 #endif
237 
238 #ifndef _H_send_buff
239 #include "send_buff.h"
240 #endif
241 
242 #ifndef _H_ses
243 #include "ses.h"
244 #endif
245 
246 #ifndef _H_ses_msg
247 #include "ses_msg.h"
248 #endif
249 
250 #ifndef _H_status_enum
251 #include "status_enum.h"
252 #endif
253 
254 #ifndef _H_status
255 #include "status.h"
256 #endif
257 
258 #ifndef _H_thd
259 #include "thd.h"
260 #endif
261 
262 #ifndef _H_tk
263 #include "tk.h"
264 #endif
265 
266 #ifndef _H_top
267 #include "top.h"
268 #endif
269 
270 #ifndef _H_tstamp
271 #include "tstamp.h"
272 #endif
273 
274 #ifndef _H_typ
275 #include "typ.h"
276 #endif
277 
278 #ifndef _H_val
279 #include "val.h"
280 #endif
281 
282 #ifndef _H_val_util
283 #include "val_util.h"
284 #endif
285 
286 #ifndef _H_var
287 #include "var.h"
288 #endif
289 
290 #ifndef _H_version
291 #include "version.h"
292 #endif
293 
294 #ifndef _H_xml_msg
295 #include "xml_msg.h"
296 #endif
297 
298 #ifndef _H_xmlns
299 #include "xmlns.h"
300 #endif
301 
302 #ifndef _H_xml_util
303 #include "xml_util.h"
304 #endif
305 
306 #ifndef _H_xml_val
307 #include "xml_val.h"
308 #endif
309 
310 #ifndef _H_xml_wr
311 #include "xml_wr.h"
312 #endif
313 
314 #ifndef _H_xpath1
315 #include "xpath1.h"
316 #endif
317 
318 #ifndef _H_xpath
319 #include "xpath.h"
320 #endif
321 
322 #ifndef _H_xpath_wr
323 #include "xpath_wr.h"
324 #endif
325 
326 #ifndef _H_xpath_yang
327 #include "xpath_yang.h"
328 #endif
329 
330 #ifndef _H_yangapi
331 #include "yangapi.h"
332 #endif
333 
334 #ifndef _H_yangconst
335 #include "yangconst.h"
336 #endif
337 
338 #ifndef _H_yang_ext
339 #include "yang_ext.h"
340 #endif
341 
342 #ifndef _H_yang_grp
343 #include "yang_grp.h"
344 #endif
345 
346 #ifndef _H_yang
347 #include "yang.h"
348 #endif
349 
350 #ifndef _H_yang_obj
351 #include "yang_obj.h"
352 #endif
353 
354 #ifndef _H_yang_parse
355 #include "yang_parse.h"
356 #endif
357 
358 #ifndef _H_yang_patch
359 #include "yang_patch.h"
360 #endif
361 
362 #ifndef _H_yang_typ
363 #include "yang_typ.h"
364 #endif
365 
366 #ifndef _H_yin
367 #include "yin.h"
368 #endif
369 
370 #ifndef _H_yinyang
371 #include "yinyang.h"
372 #endif
373 
374 #ifdef __cplusplus
375 } /* end extern 'C' */
376 #endif
377 
378 #endif /* _H_libncx */
ncx_str.h
NCX Module Library String Utility Functions.
ses.h
NETCONF Session Common definitions module.
cfg.h
ncx_feature.h
NCX Module Library YANG Feature Utility Functions.
ncx_appinfo.h
NCX Module Library Extension (Application Info) Utility Functions.
tstamp.h
Timestamp utilities.
yang_grp.h
YANG Module parser grouping statement support.
plock.h
RFC 57517 partial lock support.
val.h
Value Node Basic Support.
xml_util.h
XML Utilities.
getcb.h
GET1 and GET2 Callback Support.
status_enum.h
global error status code enumerations
log_vendor.h
Logging manager vendor API.
tk.h
NCX Syntax Token Handler.
xml_wr.h
XML Write functions.
ncx_num.h
NCX Module Library Number Utility Functions.
runstack.h
CLI run stack manager.
xpath_wr.h
Write an XPath expression to a session output in normalized format.
op.h
NETCONF protocol operations.
ncxconst.h
Contains NCX constants.
ncxmod.h
NCX Module Load Manager.
yinyang.h
Convert YIN format to YANG format for input.
help.h
YANG help text support for CLI Print help text for various templates.
ses_msg.h
NETCONF Session Message Common definitions module.
bobhash.h
BOB hash function.
version.h
NCX Release Train Version. Contains the current Yuma version ID.
xpath1.h
XPath 1.0 expression support.
def_reg.h
Definition Registry module.
blob.h
binary to string conversion for database storage
xpath.h
Schema and data model Xpath search support.
log_vendor_extern.h
Logging manager vendor API registration.
xml_val.h
Utility functions for creating value structs.
log_syslog.h
Syslog logging manager API.
yang_typ.h
YANG Module parser typedef and type statement support.
heapchk.h
Internal Heap Checking Utilities.
obj_help.h
Help command support for obj_template_t.
val_util.h
Value Node Utilities.
json_wr.h
JSON Write functions.
rpc.h
NETCONF protocol remote procedure call common definitions.
b64.h
Base64 Utilities.
yang.h
YANG Module parser utilities.
typ.h
Parameter Type Handler.
yangconst.h
Contains YANG constants separated to prevent H file include loops.
yang_patch.h
YANG Patch Media Type.
conf.h
NCX Text Config file parser.
yin.h
YIN Language Format.
xpath_yang.h
YANG-specific Xpath support.
xml_msg.h
XML and JSON Message send and receive support.
yang_ext.h
YANG Module parser extension statement support.
log.h
NCX System Logging Manager.
ncxtypes.h
YANG module data structures Many internal representations of YANG module constructs.
cli.h
command line interpreter parsing to internal val_value_t format
rpc_err.h
NETCONF protocol standard error definitions.
ncx_list.h
NCX Module Library List Utility Functions.
yang_parse.h
YANG Module parser module.
thd.h
Thread support (for now limited to netconfd)
top.h
NCX Common Top Element module.
cap.h
NETCONF protocol capabilities.
ncx.h
YANG module utility functions.
send_buff.h
Send buffer utility.
obj.h
Data Object Support.
yang_obj.h
YANG Module parser support for data-def-stmt.
grp.h
YANG Grouping Statement Handler.
plock_cb.h
RFC 57517 partial lock support Data structure definition.
xmlns.h
XML namespace support.
log_util.h
Internal SYSLOG Logging support.
status.h
Global error messages for status code enumerations.
yangapi.h
YANG-API definitions (pre-RESTCONF)
dlq.h
dlq provides general double-linked list and queue support:
var.h
NCX Variable Support. Used within a runstack by a CLI user or script.
ext.h
YANG Extension Handler.