yumapro  21.10T-10
YumaPro SDK
agt_xml.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_agt_xml
13 #define _H_agt_xml
14 /* FILE: agt_xml.h
15 *********************************************************************
16 * *
17 * P U R P O S E *
18 * *
19 *********************************************************************/
20 
27 /*********************************************************************
28 * *
29 * C H A N G E H I S T O R Y *
30 * *
31 *********************************************************************
32 
33 date init comment
34 ----------------------------------------------------------------------
35 14-oct-05 abb begun
36 2-jan-06 abb rewrite xml_consume_* API to use simpler
37  xml_node_t
38 11-feb-07 abb moved consume_node fns to agt_xml.h
39 22-aug-08 abb changed reader parameter to the session
40  control block to record error stats;
41  also errQ to msghdr to record xmlns directives
42 */
43 
44 
45 #ifndef _H_ncxtypes
46 #include "ncxtypes.h"
47 #endif
48 
49 #ifndef _H_ses
50 #include "ses.h"
51 #endif
52 
53 #ifndef _H_xmlns
54 #include "xmlns.h"
55 #endif
56 
57 #ifndef _H_xml_msg
58 #include "xml_msg.h"
59 #endif
60 
61 #ifndef _H_xml_util
62 #include "xml_util.h"
63 #endif
64 
65 #ifdef __cplusplus
66 extern "C" {
67 #endif
68 
69 /********************************************************************
70 * *
71 * F U N C T I O N S *
72 * *
73 *********************************************************************/
74 
75 
76 /* Group definied in agt_top.h */
77 
136 extern status_t
138  xml_node_t *node,
139  ncx_layer_t layer,
140  xml_msg_hdr_t *msghdr);
141 
142 
159 extern status_t
161  xml_node_t *node,
162  ncx_layer_t layer,
163  xml_msg_hdr_t *msghdr);
164 
165 
183 extern status_t
185  xml_node_t *node,
186  ncx_layer_t layer,
187  xml_msg_hdr_t *msghdr);
188 
189 
190 
207 extern status_t
209  xml_node_t *node,
210  ncx_layer_t layer,
211  xml_msg_hdr_t *msghdr);
212 
213 
214 
218 #ifdef __cplusplus
219 } /* end extern 'C' */
220 #endif
221 
222 #endif /* _H_agt_xml */
Common Encoding Message Header No longer XML specific!! Used by JSON parsing as well!! Allows common ...
Definition: xml_msg.h:351
gather node data into a simple struct.
Definition: xml_util.h:204
status_t agt_xml_consume_node(ses_cb_t *scb, xml_node_t *node, ncx_layer_t layer, xml_msg_hdr_t *msghdr)
Consume an XML node from libxml2.
Definition: agt_xml.c:141
NETCONF Session Common definitions module.
status_t agt_xml_consume_node_noeof(ses_cb_t *scb, xml_node_t *node, ncx_layer_t layer, xml_msg_hdr_t *msghdr)
Consume an XML node from libxml2.
Definition: agt_xml.c:168
YANG module data structures Many internal representations of YANG module constructs.
XML Utilities.
XML and JSON Message send and receive support.
Session Control Block.
Definition: ses.h:542
status_t
global error return code
Definition: status_enum.h:186
ncx_layer_t
Enumeration of NETCONF protocol layers.
Definition: ncxtypes.h:494
status_t agt_xml_consume_node_noadv(ses_cb_t *scb, xml_node_t *node, ncx_layer_t layer, xml_msg_hdr_t *msghdr)
Consume an XML node from libxml2.
Definition: agt_xml.c:222
status_t agt_xml_consume_node_nons(ses_cb_t *scb, xml_node_t *node, ncx_layer_t layer, xml_msg_hdr_t *msghdr)
Consume an XML node from libxml2.
Definition: agt_xml.c:196
XML namespace support.