* ISO8859-* -> UTF_8
[olsrd.git] / src / olsrd_plugin.h
1 /*
2  * Copyright (c) 2005, Bruno Randolf <bruno.randolf@4g-systems.biz>
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto-at-olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice, 
11  *   this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright notice, 
13  *   this list of conditions and the following disclaimer in the documentation 
14  *   and/or other materials provided with the distribution.
15  * * Neither the name of the UniK olsr daemon nor the names of its contributors 
16  *   may be used to endorse or promote products derived from this software 
17  *   without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
22  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
23  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
27  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  */
31
32 /* $Id: olsrd_plugin.h,v 1.7 2007/11/29 18:09:11 bernd67 Exp $ */
33
34 /*
35  * Example plugin for olsrd.org OLSR daemon
36  * Only the bare minimum
37  */
38
39 #ifndef _OLSRD_PLUGIN
40 #define _OLSRD_PLUGIN
41
42
43 /* Define the most recent version */
44 #define MOST_RECENT_PLUGIN_INTERFACE_VERSION            5
45 #define LAST_SUPPORTED_PLUGIN_INTERFACE_VERSION         4
46
47
48 /****************************************************************************
49  *                Functions that the plugin MUST provide                    *
50  ****************************************************************************/
51 #if 1
52 /* We hide them from the compiler here to allow the plugins itself to declare them
53  * as they also implement them if we activate -Wredundant-decls.
54  * Normally we leave it seen so that we enforce a check by the compiler if they are
55  * identical.
56  */
57
58 /**
59  * Plugin interface version
60  * Used by main olsrd to check plugin interface version
61  */
62 int olsrd_plugin_interface_version(void);
63
64
65 /**
66  * Initialize plugin
67  * Called after all parameters are passed
68  */
69 int olsrd_plugin_init(void);
70
71
72 /* Interface version 4 */
73 /**
74  * Register parameters from config file
75  * Called for all plugin parameters
76  */
77 int olsrd_plugin_register_param(char *key, char *value);
78
79 /* Interface version 5 */
80
81 typedef union {
82     unsigned int ui;
83     char *pc;
84 } set_plugin_parameter_addon;
85
86 typedef int set_plugin_parameter(const char *value, void *data, set_plugin_parameter_addon addon);
87
88 struct olsrd_plugin_parameters {
89     const char *name;
90     set_plugin_parameter *set_plugin_parameter;
91     void *data;
92     set_plugin_parameter_addon addon;
93 };
94
95 /**
96  * Delivers the (address of the) table and the size of the parameter description
97  */
98 void olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size);
99
100 #endif
101
102 #endif
103
104 /*
105  * Local Variables:
106  * mode: c
107  * style: linux
108  * c-basic-offset: 4
109  * indent-tabs-mode: nil
110  * End:
111  */