yumapro  24.10-3
YumaPro SDK
Loading...
Searching...
No Matches
agt_yangapi.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#ifndef _H_agt_yangapi
12#define _H_agt_yangapi
13/* FILE: agt_yangapi.h
14*********************************************************************
15* *
16* P U R P O S E *
17* *
18*********************************************************************/
19
26/*********************************************************************
27* *
28* C H A N G E H I S T O R Y *
29* *
30*********************************************************************
31
32date init comment
33----------------------------------------------------------------------
3410-apr-12 abb Begun.
35*/
36
37#ifndef _H_ses
38#include "ses.h"
39#endif
40
41#ifndef _H_status
42#include "status.h"
43#endif
44
45#ifndef _H_yangapi
46#include "yangapi.h"
47#endif
48
49#ifndef _H_yang_patch
50#include "yang_patch.h"
51#endif
52
53#ifndef _H_agt_restcmn
54#include "agt_restcmn.h"
55#endif
56
57
58#ifdef __cplusplus
59extern "C" {
60#endif
61
62
63/********************************************************************
64* *
65* C O N S T A N T S *
66* *
67*********************************************************************/
68
69
70/********************************************************************
71* *
72* T Y P E S *
73* *
74*********************************************************************/
75
76
77/********************************************************************
78* *
79* F U N C T I O N S *
80* *
81*********************************************************************/
82
101extern status_t
102 agt_yangapi_init (void);
103
104
110extern void
111 agt_yangapi_cleanup (void);
112
113
121extern boolean
123
124
143extern boolean
145 yang_patch_cb_t *pcb,
146 boolean skip_sil,
147 boolean skip_save,
148 const xmlChar *comment_str,
149 status_t *res);
150
151
163extern status_t
165 yangapi_cb_t *rcb,
166 rpc_msg_t *msg);
167
168
176
177
182#ifdef __cplusplus
183} /* end extern 'C' */
184#endif
185
186#endif /* _H_agt_yangapi */
Common function for RESTCONF and YANG-API protocols.
status_t agt_yangapi_init(void)
Initialize the agt_yangapi module.
Definition: agt_yangapi.c:832
boolean agt_yangapi_dispatch_db_api(ses_cb_t *scb, yang_patch_cb_t *pcb, boolean skip_sil, boolean skip_save, const xmlChar *comment_str, status_t *res)
Dispatch an incoming YControl DB-API request.
Definition: agt_yangapi.c:1261
agt_yangapi_context_t * agt_yangapi_get_context(void)
Get the YANG-API Context structure.
Definition: agt_yangapi.c:1782
status_t agt_yangapi_validate_method_params(ses_cb_t *scb, yangapi_cb_t *rcb, rpc_msg_t *msg)
validate that the operation is supported for the URI parameters given.
Definition: agt_yangapi.c:1642
boolean agt_yangapi_dispatch(ses_cb_t *scb)
Dispatch an incoming Yuma REST API request.
Definition: agt_yangapi.c:880
void agt_yangapi_cleanup(void)
Cleanup the agt_yangapi module.
Definition: agt_yangapi.c:857
status_t
global error return code
Definition: status_enum.h:210
NETCONF Session Common definitions module.
Global error messages for status code enumerations.
module context node with cached schema tree and API template for retrieval (root)
Definition: agt_restcmn.h:170
NETCONF Server and Client RPC Request/Reply Message Header.
Definition: rpc.h:185
Session Control Block.
Definition: ses.h:573
One YANG Patch Request.
Definition: yang_patch.h:155
Restapi Control Block Used by RESTCONF to hold parse and request processing state.
Definition: yangapi.h:351
YANG Patch Media Type.
YANG-API definitions (pre-RESTCONF)