yumapro  21.10T-9
YumaPro SDK
agt_yangapi_edit.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012 - 2021, YumaWorks, Inc., All Rights Reserved.
3  *
4  * Unless required by applicable law or agreed to in writing,
5  * software distributed under the License is distributed on an
6  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
7  * KIND, either express or implied. See the License for the
8  * specific language governing permissions and limitations
9  * under the License.
10  */
11 #if defined(WITH_YANGAPI) || defined(WITH_YCONTROL) || defined(WITH_RESTCONF)
12 #ifndef _H_agt_yangapi_edit
13 #define _H_agt_yangapi_edit
14 /* FILE: agt_yangapi_edit.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 17-mar-13 abb Begun.; split from agt_yangapi.c
36 */
37 
38 #ifndef _H_ses
39 #include "ses.h"
40 #endif
41 
42 #ifndef _H_rpc
43 #include "rpc.h"
44 #endif
45 
46 #ifndef _H_status
47 #include "status.h"
48 #endif
49 
50 #ifndef _H_yangapi
51 #include "yangapi.h"
52 #endif
53 
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57 
58 
59 /********************************************************************
60 * *
61 * C O N S T A N T S *
62 * *
63 *********************************************************************/
64 
65 
66 /********************************************************************
67 * *
68 * T Y P E S *
69 * *
70 *********************************************************************/
71 
72 
73 /********************************************************************
74 * *
75 * F U N C T I O N S *
76 * *
77 *********************************************************************/
78 
79 /* Group defined in agt_yangapi.h */
80 
96 extern status_t
97  agt_yangapi_edit_request (ses_cb_t *scb,
98  yangapi_cb_t *rcb,
99  rpc_msg_t *msg);
100 
101 
102 
120 extern status_t
121  agt_yangapi_edit_request_ex (ses_cb_t *scb,
122  yangapi_cb_t *rcb,
123  rpc_msg_t *msg,
124  val_value_t *force_editval,
125  op_editop_t force_editop,
126  boolean skip_sil,
127  boolean skip_save,
128  const xmlChar *comment_str,
129  yang_patch_edit_t *edit);
130 
131 
132 
133 
154 extern status_t
155  agt_yangapi_edit_request_ex2 (ses_cb_t *scb,
156  yangapi_cb_t *rcb,
157  rpc_msg_t *msg,
158  val_value_t *force_editval,
159  op_editop_t force_editop,
160  boolean skip_sil,
161  boolean skip_save,
162  boolean check_candidate,
163  boolean candidate_start_dirty,
164  const xmlChar *comment_str,
165  yang_patch_edit_t *edit);
166 
167 
171 #ifdef __cplusplus
172 } /* end extern 'C' */
173 #endif
174 
175 #endif /* _H_agt_yangapi */
176 #endif // WITH_YANGAPI || WITH_YCONTROL || WITH_RESTCONF
yangapi_cb_t
Restapi Control Block Used by RESTCONF to hold parse and request processing state.
Definition: yangapi.h:224
rpc_msg_t
NETCONF Server and Client RPC Request/Reply Message Header.
Definition: rpc.h:181
yang_patch_edit_t
Represents one YANG Patch edit entry.
Definition: yang_patch.h:118
ses.h
NETCONF Session Common definitions module.
yangapi.h
YANG-API definitions (pre-RESTCONF)
agt_yangapi_edit_request_ex
status_t agt_yangapi_edit_request_ex(ses_cb_t *scb, yangapi_cb_t *rcb, rpc_msg_t *msg, val_value_t *force_editval, op_editop_t force_editop, boolean skip_sil, boolean skip_save, const xmlChar *comment_str, yang_patch_edit_t *edit)
Perform an internal <edit-config> and <commit> if needed.
Definition: agt_yangapi_edit.c:1336
op_editop_t
op_editop_t
NETCONF edit-config operation types.
Definition: op.h:122
val_value_t
one value to match one type
Definition: val.h:870
ses_cb_t
Session Control Block.
Definition: ses.h:542
status_t
status_t
global error return code
Definition: status_enum.h:186
rpc.h
NETCONF protocol remote procedure call common definitions.
status.h
Global error messages for status code enumerations.
agt_yangapi_edit_request
status_t agt_yangapi_edit_request(ses_cb_t *scb, yangapi_cb_t *rcb, rpc_msg_t *msg)
Perform an internal <edit-config> and <commit> if needed.
Definition: agt_yangapi_edit.c:1299
agt_yangapi_edit_request_ex2
status_t agt_yangapi_edit_request_ex2(ses_cb_t *scb, yangapi_cb_t *rcb, rpc_msg_t *msg, val_value_t *force_editval, op_editop_t force_editop, boolean skip_sil, boolean skip_save, boolean check_candidate, boolean candidate_start_dirty, const xmlChar *comment_str, yang_patch_edit_t *edit)
Handle an edit request from DB-API (extra 2)
Definition: agt_yangapi_edit.c:1377