General cleanups in header files
[olsrd.git] / src / neighbor_table.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: neighbor_table.h,v 1.13 2005/02/20 18:52:18 kattemat Exp $
40  */
41
42
43 #ifndef _OLSR_NEIGH_TBL
44 #define _OLSR_NEIGH_TBL
45
46 #include "olsr_types.h"
47 #include "hashing.h"
48
49
50 struct neighbor_2_list_entry 
51 {
52   struct neighbor_2_entry      *neighbor_2;
53   clock_t                      neighbor_2_timer;
54   struct neighbor_2_list_entry *next;
55   struct neighbor_2_list_entry *prev;
56 };
57
58
59
60 struct neighbor_entry
61 {
62   union olsr_ip_addr           neighbor_main_addr;
63   olsr_u8_t                    status;
64   olsr_u8_t                    willingness;
65   olsr_bool                    is_mpr;
66   olsr_bool                    was_mpr; /* Used to detect changes in MPR */
67   olsr_bool                    skip;
68   int                          neighbor_2_nocov;
69   int                          linkcount;
70   struct neighbor_2_list_entry neighbor_2_list; 
71   struct neighbor_entry        *next;
72   struct neighbor_entry        *prev;
73 };
74
75
76 #ifndef OLSR_PLUGIN
77
78 /*
79  * The neighbor table
80  */
81
82 struct neighbor_entry neighbortable[HASHSIZE];
83
84 void
85 olsr_init_neighbor_table(void);
86
87 int
88 olsr_delete_neighbor_2_pointer(struct neighbor_entry *, union olsr_ip_addr *);
89
90 struct neighbor_2_list_entry *
91 olsr_lookup_my_neighbors(struct neighbor_entry *, union olsr_ip_addr *);
92
93 int
94 olsr_delete_neighbor_table(union olsr_ip_addr *);
95
96 struct neighbor_entry *
97 olsr_insert_neighbor_table(union olsr_ip_addr *);
98
99 struct neighbor_entry *
100 olsr_lookup_neighbor_table(union olsr_ip_addr *);
101
102 struct neighbor_entry *
103 olsr_lookup_neighbor_table_alias(union olsr_ip_addr *);
104
105 void
106 olsr_time_out_two_hop_neighbors(struct neighbor_entry  *);
107
108 void
109 olsr_time_out_neighborhood_tables(void);
110
111 void
112 olsr_print_neighbor_table(void);
113
114
115 int
116 update_neighbor_status(struct neighbor_entry *, int);
117
118 #endif
119 #endif