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