yumapro  24.10-3
YumaPro SDK
Loading...
Searching...
No Matches
agt_tree_get2.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
3 * Copyright (c) 2012 - 2023, 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_tree_get2
13#define _H_agt_tree_get2
14
15/* FILE: agt_tree_get2.h
16*********************************************************************
17* *
18* P U R P O S E *
19* *
20*********************************************************************/
21
29/*********************************************************************
30* *
31* C H A N G E H I S T O R Y *
32* *
33*********************************************************************
34
35date init comment
36----------------------------------------------------------------------
3709-may-15 abb Begun; split from agt_tree.h
38
39*/
40
41#ifndef _H_getcb
42#include "getcb.h"
43#endif
44
45#ifndef _H_ncxtypes
46#include "ncxtypes.h"
47#endif
48
49#ifndef _H_obj
50#include "obj.h"
51#endif
52
53#ifndef _H_ses
54#include "ses.h"
55#endif
56
57#ifndef _H_val
58#include "val.h"
59#endif
60
61#ifndef _H_xml_msg
62#include "xml_msg.h"
63#endif
64
65#ifdef __cplusplus
66extern "C" {
67#endif
68
69
70/* group defined in agt_tree.h */
71
78/********************************************************************
79* *
80* F U N C T I O N S *
81* *
82*********************************************************************/
83
84
115extern status_t
116 agt_tree_get2_retrieve_value (xml_msg_hdr_t *msg,
117 ses_cb_t *scb,
118 ncx_filptr_t *parent_filptr,
119 ncx_filptr_t *filptr,
120 val_value_t *filchild,
121 obj_template_t *filobj,
122 val_value_t *curval,
123 boolean getop,
124 boolean *force_remove,
125 getcb_api_mode_t api_mode,
126 int32 startindent);
127
128
144extern status_t
145 agt_tree_get2_check_value (xml_msg_hdr_t *msg,
146 ses_cb_t *scb,
147 obj_template_t *filobj,
148 val_value_t *curval);
149
150
177extern status_t
178 agt_tree_get2_retrieve_aio_values (xml_msg_hdr_t *msg,
179 ses_cb_t *scb,
180 ncx_filptr_t *parent_filptr,
181 ncx_filptr_t *filptr,
182 val_value_t *filchild,
183 obj_template_t *filobj,
184 val_value_t *curval,
185 boolean getop,
186 getcb_api_mode_t api_mode,
187 int32 startindent);
188
189
193#ifdef __cplusplus
194} /* end extern 'C' */
195#endif
196
197#endif /* _H_agt_tree_get2 */
getcb.h
GET1 and GET2 Callback Support.
agt_tree_get2_retrieve_value
status_t agt_tree_get2_retrieve_value(xml_msg_hdr_t *msg, ses_cb_t *scb, ncx_filptr_t *parent_filptr, ncx_filptr_t *filptr, val_value_t *filchild, obj_template_t *filobj, val_value_t *curval, boolean getop, boolean *force_remove, getcb_api_mode_t api_mode, int32 startindent)
Get the value for the specified object via the get2 callback or check the parent result for the node.
Definition: agt_tree_get2.c:2101
agt_tree_get2_check_value
status_t agt_tree_get2_check_value(xml_msg_hdr_t *msg, ses_cb_t *scb, obj_template_t *filobj, val_value_t *curval)
Get the value for the specified object via the get2 callback and just simple check if it is exist or ...
Definition: agt_tree_get2.c:2220
agt_tree_get2_retrieve_aio_values
status_t agt_tree_get2_retrieve_aio_values(xml_msg_hdr_t *msg, ses_cb_t *scb, ncx_filptr_t *parent_filptr, ncx_filptr_t *filptr, val_value_t *filchild, obj_template_t *filobj, val_value_t *curval, boolean getop, getcb_api_mode_t api_mode, int32 startindent)
Get the value for the specified object via the get2 callback or check the parent result for the node.
Definition: agt_tree_get2.c:2301
status_t
status_t
global error return code
Definition: status_enum.h:210
ncxtypes.h
YANG module data structures Many internal representations of YANG module constructs.
obj.h
Data Object Support.
ses.h
NETCONF Session Common definitions module.
ncx_filptr_t
struct for holding r/o pointer to generic internal node for filtering purposes
Definition: ncxtypes.h:1061
obj_template_t
One YANG data-def-stmt.
Definition: obj.h:1229
ses_cb_t
Session Control Block.
Definition: ses.h:573
val_value_t
one value to match one type
Definition: val.h:912
xml_msg_hdr_t
Common Encoding Message Header No longer XML specific!! Used by JSON and CBOR parsing as well!...
Definition: xml_msg.h:404
val.h
Value Node Basic Support.
xml_msg.h
XML and JSON Message send and receive support.