info: java: update workspace
[olsrd.git] / src / olsrd_plugin.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * (c) by the OLSR project
5  *
6  * See our Git repository to find out who worked on this file
7  * and thus is a copyright holder on it.
8  *
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 /*
47  * Example plugin for olsrd.org OLSR daemon
48  * Only the bare minimum
49  */
50
51 #ifndef _OLSRD_PLUGIN
52 #define _OLSRD_PLUGIN
53
54 /* Define the most recent version */
55 #define MOST_RECENT_PLUGIN_INTERFACE_VERSION            5
56 #define LAST_SUPPORTED_PLUGIN_INTERFACE_VERSION         4
57
58 /****************************************************************************
59  *                Functions that the plugin MUST provide                    *
60  ****************************************************************************/
61
62 /**
63  * Plugin interface version
64  * Used by main olsrd to check plugin interface version
65  */
66 int olsrd_plugin_interface_version(void);
67
68 /**
69  * Initialize plugin
70  * Called after all parameters are passed
71  */
72 int olsrd_plugin_init(void);
73
74 /* Interface version 4 */
75
76 /**
77  * Register parameters from config file
78  * Called for all plugin parameters
79  */
80 int olsrd_plugin_register_param(char *key, char *value);
81
82 /* Interface version 5 */
83
84 typedef union {
85   unsigned int ui;
86   char *pc;
87 } set_plugin_parameter_addon;
88
89 typedef int set_plugin_parameter(const char *value, void *data, set_plugin_parameter_addon addon);
90
91 struct olsrd_plugin_parameters {
92   const char *name;
93   set_plugin_parameter *set_plugin_parameter;
94   void *data;
95   set_plugin_parameter_addon addon;
96 };
97
98 /**
99  * Delivers the (address of the) table and the size of the parameter description
100  */
101 void olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size);
102
103 #endif /* _OLSRD_PLUGIN */
104
105 /*
106  * Local Variables:
107  * mode: c
108  * style: linux
109  * c-basic-offset: 4
110  * indent-tabs-mode: nil
111  * End:
112  */