yumapro  23.10T-6
YumaPro SDK
Loading...
Searching...
No Matches
agt_restconf.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_restconf
12#define _H_agt_restconf
13/* FILE: agt_restconf.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----------------------------------------------------------------------
3418-nov-13 abb Begun; split fromagt_yangapi.h
35
36
37*/
38
39#ifndef _H_status_enum
40#include "status_enum.h"
41#endif
42
43#ifndef _H_status
44#include "status.h"
45#endif
46
47#ifndef _H_agt_restcmn
48#include "agt_restcmn.h"
49#endif
50
51#ifdef __cplusplus
52extern "C" {
53#endif
54
55
56/********************************************************************
57* *
58* C O N S T A N T S *
59* *
60*********************************************************************/
61
62/********************************************************************
63* *
64* T Y P E S *
65* *
66*********************************************************************/
67
68/********************************************************************
69* *
70* F U N C T I O N S *
71* *
72*********************************************************************/
73
74
75
98extern status_t
100 yangapi_cb_t *rcb,
101 rpc_msg_t *msg,
102 boolean *errdone);
103
104
116extern status_t
118 yangapi_cb_t *rcb,
119 rpc_msg_t *msg);
120
121
127extern status_t
128 agt_restconf_init (void);
129
130
136extern void
138
139
147extern boolean
149
150
161extern boolean
163 boolean scb_is_static);
164
165
166#if defined(WITH_GNMI) && defined(WITH_RESTCONF) && defined(WITH_YCONTROL)
181extern boolean
183#endif // WITH_GNMI
184
185
191extern agt_restconf_data_t *
193
194
200extern val_value_t *
202
203
204#ifdef STATIC_LINK
205#ifdef WITH_RESTCONF
213extern status_t
215
216
224extern status_t
226
227
234extern void
236
237#endif // WITH_RESTCONF
238#endif // STATIC_LINK
239
240
245#ifdef __cplusplus
246} /* end extern 'C' */
247#endif
248
249#endif /* _H_agt_restconf */
Common function for RESTCONF and YANG-API protocols.
status_t agt_restconf_init(void)
Initialize the agt_restconf module.
Definition: agt_restconf.c:1925
boolean agt_restconf_dispatch_gnmi_get(ses_cb_t *scb)
Dispatch an incoming gNMI GET request with help of RESTCONF.
Definition: agt_restconf.c:2800
status_t agt_restconf_static_restmon_init1(void)
Load the ietf-restconf-monitoring SIL even if it is statically linked.
Definition: agt_restconf.c:2728
status_t agt_restconf_setup_fields_nodes(ses_cb_t *scb, yangapi_cb_t *rcb, rpc_msg_t *msg, boolean *errdone)
Setup fields nodes if parameter is used.
Definition: agt_restconf.c:1353
boolean agt_restconf_dispatch_ex(ses_cb_t *scb, boolean scb_is_static)
Dispatch an incoming RESTCONF request (Extended)
Definition: agt_restconf.c:1996
val_value_t * agt_restconf_get_root(void)
Get the RESTCONF Context root val_value_t node.
Definition: agt_restconf.c:2702
boolean agt_restconf_dispatch(ses_cb_t *scb)
Dispatch an incoming RESTCONF request.
Definition: agt_restconf.c:1974
void agt_restconf_static_restmon_cleanup(void)
Call the cleanup function for the ietf-restconf-monitoring module.
Definition: agt_restconf.c:2768
agt_restconf_data_t * agt_restconf_get_context(void)
Get the RESTCONF Context structure.
Definition: agt_restconf.c:2686
status_t agt_restconf_static_restmon_init2(void)
Call the ietf-restconf-monitoring init2 function.
Definition: agt_restconf.c:2748
status_t agt_restconf_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_restconf.c:1545
void agt_restconf_cleanup(void)
Cleanup the agt_yangapi module.
Definition: agt_restconf.c:1950
status_t
global error return code
Definition: status_enum.h:210
Global error messages for status code enumerations.
global error status code enumerations
RESTCONF structure for data.
Definition: agt_restcmn.h:183
NETCONF Server and Client RPC Request/Reply Message Header.
Definition: rpc.h:181
Session Control Block.
Definition: ses.h:573
one value to match one type
Definition: val.h:911
Restapi Control Block Used by RESTCONF to hold parse and request processing state.
Definition: yangapi.h:224