glitch in the license text detected by hyazinthe, thank you!
[oweals/gnunet.git] / src / transport / plugin_transport_xu.h
1 /*
2      This file is part of GNUnet
3      Copyright (C) 2010-2014 GNUnet e.V.
4
5      GNUnet is free software: you can redistribute it and/or modify it
6      under the terms of the GNU Affero General Public License as published
7      by the Free Software Foundation, either version 3 of the License,
8      or (at your option) any later version.
9
10      GNUnet is distributed in the hope that it will be useful, but
11      WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13      Affero General Public License for more details.
14 */
15
16 /**
17  * @file transport/plugin_transport_xu.h
18  * @brief Implementation of the XU transport protocol
19  * @author Christian Grothoff
20  * @author Nathan Evans
21  * @author Matthias Wachs
22  */
23 #ifndef PLUGIN_TRANSPORT_XU_H
24 #define PLUGIN_TRANSPORT_XU_H
25
26 #include "platform.h"
27 #include "gnunet_hello_lib.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_fragmentation_lib.h"
30 #include "gnunet_protocols.h"
31 #include "gnunet_resolver_service.h"
32 #include "gnunet_signatures.h"
33 #include "gnunet_constants.h"
34 #include "gnunet_statistics_service.h"
35 #include "gnunet_transport_service.h"
36 #include "gnunet_transport_plugin.h"
37 #include "transport.h"
38
39 #define LOG(kind,...) GNUNET_log_from (kind, "transport-xu", __VA_ARGS__)
40
41 #define PLUGIN_NAME "xu"
42
43 #define DEBUG_XU GNUNET_NO
44
45 #define DEBUG_XU_BROADCASTING GNUNET_NO
46
47 /**
48  * MTU for fragmentation subsystem.  Should be conservative since
49  * all communicating peers MUST work with this MTU.
50  */
51 #define XU_MTU 1400
52
53
54 GNUNET_NETWORK_STRUCT_BEGIN
55 /**
56  * Network format for IPv4 addresses.
57  */
58 struct IPv4XuAddress
59 {
60   /**
61    * Optional options and flags for this address
62    */
63   uint32_t options GNUNET_PACKED;
64
65   /**
66    * IPv4 address, in network byte order.
67    */
68   uint32_t ipv4_addr GNUNET_PACKED;
69
70   /**
71    * Port number, in network byte order.
72    */
73   uint16_t u4_port GNUNET_PACKED;
74 };
75
76
77 /**
78  * Network format for IPv6 addresses.
79  */
80 struct IPv6XuAddress
81 {
82   /**
83    * Optional options and flags for this address
84    */
85   uint32_t options GNUNET_PACKED;
86
87   /**
88    * IPv6 address.
89    */
90   struct in6_addr ipv6_addr GNUNET_PACKED;
91
92   /**
93    * Port number, in network byte order.
94    */
95   uint16_t u6_port GNUNET_PACKED;
96 };
97 GNUNET_NETWORK_STRUCT_END
98
99 /**
100  * Either an IPv4 or IPv6 XU address.  Note that without a "length",
101  * one cannot tell which one of the two types this address represents.
102  */
103 union XuAddress
104 {
105   /**
106    * IPv4 case.
107    */
108   struct IPv4XuAddress v4;
109
110   /**
111    * IPv6 case.
112    */
113   struct IPv6XuAddress v6;
114 };
115
116
117 /**
118  * Information we track for each message in the queue.
119  */
120 struct XU_MessageWrapper;
121
122
123 /**
124  * Closure for #append_port().
125  */
126 struct PrettyPrinterContext;
127
128
129 /**
130  * Encapsulation of all of the state of the plugin.
131  */
132 struct Plugin
133 {
134
135   /**
136    * Our environment.
137    */
138   struct GNUNET_TRANSPORT_PluginEnvironment *env;
139
140   /**
141    * Session of peers with whom we are currently connected,
142    * map of peer identity to `struct GNUNET_ATS_Session *`.
143    */
144   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
145
146   /**
147    * ID of select task for IPv4
148    */
149   struct GNUNET_SCHEDULER_Task *select_task_v4;
150
151   /**
152    * ID of select task for IPv6
153    */
154   struct GNUNET_SCHEDULER_Task *select_task_v6;
155
156   /**
157    * Address we were told to bind to exclusively (IPv4).
158    */
159   char *bind4_address;
160
161   /**
162    * Address we were told to bind to exclusively (IPv6).
163    */
164   char *bind6_address;
165
166   /**
167    * Handle to NAT traversal support.
168    */
169   struct GNUNET_NAT_Handle *nat;
170
171   /**
172    * Handle to NAT traversal support.
173    */
174   struct GNUNET_NAT_STUN_Handle *stun;
175
176   /**
177    * The read socket for IPv4
178    */
179   struct GNUNET_NETWORK_Handle *sockv4;
180
181   /**
182    * The read socket for IPv6
183    */
184   struct GNUNET_NETWORK_Handle *sockv6;
185
186   /**
187    * Running pretty printers: head
188    */
189   struct PrettyPrinterContext *ppc_dll_head;
190
191   /**
192    * Running pretty printers: tail
193    */
194   struct PrettyPrinterContext *ppc_dll_tail;
195
196   /**
197    * Function to call about session status changes.
198    */
199   GNUNET_TRANSPORT_SessionInfoCallback sic;
200
201   /**
202    * Closure for @e sic.
203    */
204   void *sic_cls;
205
206   /**
207    * IPv6 multicast address
208    */
209   struct sockaddr_in6 ipv6_multicast_address;
210
211   /**
212    * Broadcast interval
213    */
214   struct GNUNET_TIME_Relative broadcast_interval;
215
216   /**
217    * Bytes currently in buffer
218    */
219   int64_t bytes_in_buffer;
220
221   /**
222    * Address options
223    */
224   uint32_t myoptions;
225
226   /**
227    * Is IPv6 enabled: #GNUNET_YES or #GNUNET_NO
228    */
229   int enable_ipv6;
230
231   /**
232    * Is IPv4 enabled: #GNUNET_YES or #GNUNET_NO
233    */
234   int enable_ipv4;
235
236   /**
237    * Port we listen on.
238    */
239   uint16_t port;
240
241   /**
242    * Port we advertise on.
243    */
244   uint16_t aport;
245
246 };
247
248
249 /**
250  * Function called for a quick conversion of the binary address to
251  * a numeric address.  Note that the caller must not free the
252  * address and that the next call to this function is allowed
253  * to override the address again.
254  *
255  * @param cls closure
256  * @param addr binary address (a `union XuAddress`)
257  * @param addrlen length of the @a addr
258  * @return string representing the same address
259  */
260 const char *
261 xu_address_to_string (void *cls,
262                        const void *addr,
263                        size_t addrlen);
264
265
266 /*#ifndef PLUGIN_TRANSPORT_XU_H*/
267 #endif
268 /* end of plugin_transport_xu.h */