8ac0d20cffa882627e2de499d071eff46737e7f6
[oonf.git] / include / oonf / generic / dlep / dlep_interface.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * @file
44  */
45
46 #ifndef DLEP_INTERFACE_H_
47 #define DLEP_INTERFACE_H_
48
49 #include <oonf/libcommon/avl.h>
50 #include <oonf/oonf.h>
51 #include <oonf/libcore/oonf_logging.h>
52 #include <oonf/subsystems/oonf_packet_socket.h>
53
54 #define DLEP_IF_UDP_NONE_STR           "none"
55 #define DLEP_IF_UDP_SINGLE_SESSION_STR "single_session"
56 #define DLEP_IF_UDP_ALWAYS_STR         "always"
57
58 enum dlep_if_udp_mode{
59   /* never handle UDP */
60   DLEP_IF_UDP_NONE,
61
62   /* just use UDP if no session is active */
63   DLEP_IF_UDP_SINGLE_SESSION,
64
65   /* always handle UDP */
66   DLEP_IF_UDP_ALWAYS,
67 };
68
69 /**
70  * Interface that is used for one or multiple dlep sessions
71  */
72 struct dlep_if {
73   /*! pseudo session for UDP communication on interface */
74   struct dlep_session session;
75
76   /*! name of layer2 interface */
77   char l2_ifname[IF_NAMESIZE];
78
79   /*! UDP socket for discovery */
80   struct oonf_packet_managed udp;
81
82   /*! UDP socket configuration */
83   struct oonf_packet_managed_config udp_config;
84
85   /*! dynamic buffer for UDP output */
86   struct autobuf udp_out;
87
88   /*! decides when/if UDP should be sent/processed */
89   enum dlep_if_udp_mode udp_mode;
90
91   /*! true if this interface is used for DLEP radio */
92   bool radio;
93
94   /*! hook into session tree, interface name is the key */
95   struct avl_node _node;
96
97   /*! tree of all sessions of same type (radio/router) on this interface */
98   struct avl_tree session_tree;
99 };
100
101 struct avl_tree *dlep_if_get_tree(bool radio);
102 int dlep_if_add(struct dlep_if *interf, const char *ifname, const struct oonf_layer2_origin *l2_origin,
103   const struct oonf_layer2_origin *l2_default_origin,
104   int (*if_changed)(struct os_interface_listener *), enum oonf_log_source log_src, bool radio);
105 void dlep_if_remove(struct dlep_if *interface);
106
107 #endif /* DLEP_INTERFACE_H_ */