CliXoN
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
clixon_netconf.h
Go to the documentation of this file.
1 /*
2  *
3  ***** BEGIN LICENSE BLOCK *****
4 
5  Copyright (C) 2009-2017 Olof Hagsand and Benny Holmgren
6 
7  This file is part of CLIXON.
8 
9  Licensed under the Apache License, Version 2.0 (the "License");
10  you may not use this file except in compliance with the License.
11  You may obtain a copy of the License at
12 
13  http://www.apache.org/licenses/LICENSE-2.0
14 
15  Unless required by applicable law or agreed to in writing, software
16  distributed under the License is distributed on an "AS IS" BASIS,
17  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  See the License for the specific language governing permissions and
19  limitations under the License.
20 
21  Alternatively, the contents of this file may be used under the terms of
22  the GNU General Public License Version 3 or later (the "GPL"),
23  in which case the provisions of the GPL are applicable instead
24  of those above. If you wish to allow use of your version of this file only
25  under the terms of the GPL, and not to allow others to
26  use your version of this file under the terms of Apache License version 2,
27  indicate your decision by deleting the provisions above and replace them with
28  the notice and other provisions required by the GPL. If you do not delete
29  the provisions above, a recipient may use your version of this file under
30  the terms of any one of the Apache License version 2 or the GPL.
31 
32  ***** END LICENSE BLOCK *****
33 
34  *
35  * The exported interface to plugins. External apps (eg frontend netconf plugins)
36  * should only include this file (not the netconf_*.h)
37  */
38 
39 #ifndef _CLIXON_NETCONF_H_
40 #define _CLIXON_NETCONF_H_
41 
42 /*
43  * Types
44  */
45 typedef int (*netconf_cb_t)(
46  clicon_handle h,
47  cxobj *xn, /* Request: <rpc><xn></rpc> */
48  cxobj **xret, /* Return xml tree, eg <rpc-reply>... */
49  void *arg /* Argument given at netconf_register_callback() */
50  );
51 
52 /*
53  * Prototypes
54  * (Duplicated. Also in netconf_*.h)
55  */
56 int netconf_output(int s, cbuf *xf, char *msg);
57 
58 int netconf_register_callback(clicon_handle h,
59  netconf_cb_t cb, /* Callback called */
60  void *arg, /* Arg to send to callback */
61  char *tag); /* Xml tag when callback is made */
62 
63 int netconf_xpath(cxobj *xsearch,
64  cxobj *xfilter,
65  cbuf *xf, cbuf *xf_err,
66  cxobj *xt);
67 
68 
69 #endif /* _CLIXON_NETCONF_H_ */
int(* netconf_cb_t)(clicon_handle h, cxobj *xn, cxobj **xret, void *arg)
Definition: clixon_netconf.h:45
int netconf_register_callback(clicon_handle h, netconf_cb_t cb, void *arg, char *tag)
Definition: netconf_plugin.c:229
int netconf_output(int s, cbuf *xf, char *msg)
Definition: netconf_lib.c:206
int netconf_xpath(cxobj *xsearch, cxobj *xfilter, cbuf *xf, cbuf *xf_err, cxobj *xt)