- added mini plugin as an example and for testing the new plugin interface
[olsrd.git] / src / plugin_loader.h
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto@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 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  * $Id: plugin_loader.h,v 1.14 2005/05/26 16:09:26 br1 Exp $
40  */
41
42 #ifndef _OLSR_PLUGIN_LOADER
43 #define _OLSR_PLUGIN_LOADER
44
45 #include <dlfcn.h>
46 #include <stdio.h>
47 #include "olsr_types.h"
48 #include "olsr_cfg.h"
49
50 /* Data to sent to the plugin with the register_olsr_function call */
51 struct olsr_plugin_data
52 {
53   int ipversion;
54   union olsr_ip_addr *main_addr;
55   int (*olsr_plugin_io)(int, void *, size_t);
56 };
57
58 #ifndef OLSR_PLUGIN
59
60 #define MAX_LIBS 10
61 #define PLUGIN_INTERFACE_VERSION 4
62
63
64 struct olsr_plugin
65 {
66   /* The handle */
67   void *dlhandle;
68   
69   struct plugin_param *params;
70   int plugin_interface_version;
71   
72   /* old interface (PLUGIN_INTERFACE_VERSION <= 3) */
73   int (*register_olsr_data)(struct olsr_plugin_data *);
74   int (*plugin_io)(int, void *, size_t); /* Multi - purpose function */
75
76   /* new interface (PLUGIN_INTERFACE_VERSION >= 4)*/
77   int (*register_param)(char *, char *);
78   int (*plugin_init)(void);
79   
80   struct olsr_plugin *next;
81 };
82
83 int
84 olsr_load_plugins(void);
85
86 void
87 olsr_close_plugins(void);
88
89 int
90 olsr_plugin_io(int, void *, size_t);
91
92 #endif
93 #endif