babeld/neighbour.h

   1 /*
   2 Copyright (c) 2007, 2008 by Juliusz Chroboczek
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a copy
   5 of this software and associated documentation files (the "Software"), to deal
   6 in the Software without restriction, including without limitation the rights
   7 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8 copies of the Software, and to permit persons to whom the Software is
   9 furnished to do so, subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in
  12 all copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20 THE SOFTWARE.
  21 */
  22
  23 #ifndef BABEL_NEIGHBOUR_H
  24 #define BABEL_NEIGHBOUR_H
  25
  26 struct neighbour {
  27     struct neighbour *next;
  28     /* This is -1 when unknown, so don't make it unsigned */
  29     int hello_seqno;
  30     unsigned char address[16];
  31     unsigned short reach;
  32     unsigned short txcost;
  33     struct timeval hello_time;
  34     struct timeval ihu_time;
  35     unsigned short hello_interval; /* in centiseconds */
  36     unsigned short ihu_interval;   /* in centiseconds */
  37     /* Used for RTT estimation. */
  38     /* Absolute time (modulo 2^32) at which the Hello was sent,
  39        according to remote clock. */
  40     unsigned int hello_send_us;
  41     struct timeval hello_rtt_receive_time;
  42     unsigned int rtt;
  43     struct timeval rtt_time;
  44     struct interface *ifp;
  45 };
  46
  47 extern struct neighbour *neighs;
  48
  49 #define FOR_ALL_NEIGHBOURS(_neigh) \
  50     for(_neigh = neighs; _neigh; _neigh = _neigh->next)
  51
  52 int neighbour_valid(struct neighbour *neigh);
  53 void flush_neighbour(struct neighbour *neigh);
  54 struct neighbour *find_neighbour(const unsigned char *address,
  55                                  struct interface *ifp);
  56 int update_neighbour(struct neighbour *neigh, int hello, int hello_interval);
  57 unsigned check_neighbours(void);
  58 unsigned neighbour_txcost(struct neighbour *neigh);
  59 unsigned neighbour_rxcost(struct neighbour *neigh);
  60 unsigned neighbour_rttcost(struct neighbour *neigh);
  61 unsigned neighbour_cost(struct neighbour *neigh);
  62 int valid_rtt(struct neighbour *neigh);
  63
  64 #endif /* BABEL_NEIGHBOUR_H */