58a9b52727194c92a67ab1fe39eb772d4c827dab
[olsrd.git] / lib / nameservice / src / nameservice.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: nameservice.h,v 1.5 2005/03/02 22:59:55 tlopatic Exp $ */
33  
34 /*
35  * Dynamic linked library for UniK OLSRd
36  */
37
38 #ifndef _NAMESERVICE_PLUGIN
39 #define _NAMESERVICE_PLUGIN
40
41 #include "olsrd_plugin.h"
42
43
44 #define PLUGIN_NAME     "OLSRD nameservice plugin"
45 #define PLUGIN_VERSION  "0.2"
46 #define PLUGIN_AUTHOR   "Bruno Randolf"
47
48
49 #define MESSAGE_TYPE            130
50 #define PARSER_TYPE             MESSAGE_TYPE
51 #define EMISSION_INTERVAL       120 /* two minutes */
52 #define NAME_VALID_TIME         3600 /* one hour */
53
54 #define NAME_PROTOCOL_VERSION   1
55
56 #define MAX_NAME 255
57 #define MAX_FILE 255
58 #define MAX_SUFFIX 255
59
60
61 struct name_entry
62 {
63         union olsr_ip_addr      ip;
64         olsr_u16_t              type;
65         char                    *name;
66         int                     len;
67         struct name_entry       *next;          /* linked list */
68 };
69
70 /* database entry */
71 struct db_entry
72 {
73         union olsr_ip_addr      originator;     /* IP address of the node this entry describes */
74         struct timeval          timer;          /* Validity time */
75         struct name_entry       *names;         /* list of names this originator declares */
76         struct db_entry         *next;          /* linked list */
77 };
78
79
80 /* Timeout function to register with the sceduler */
81 void
82 olsr_timeout(void);
83
84 /* Parser function to register with the sceduler */
85 void
86 olsr_parser(union olsr_message *, struct interface *, union olsr_ip_addr *);
87
88 /* Event function to register with the sceduler */
89 void
90 olsr_event(void *);
91
92 int
93 encap_namemsg(struct namemsg *);
94
95 void
96 decap_namemsg(struct namemsg *, struct name_entry**);
97
98 void
99 update_name_entry(union olsr_ip_addr *, struct namemsg *, double);
100
101 void
102 write_name_table(void);
103
104 int
105 register_olsr_param(char *key, char *value);
106
107 void 
108 free_name_entry_list(struct name_entry **list);
109
110 olsr_bool
111 allowed_ip(union olsr_ip_addr *addr);
112
113 void
114 name_constructor(void);
115
116 #endif