2 This file is part of GNUnet
3 Copyright (C) 2010-2014 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file transport/plugin_transport_xu.h
23 * @brief Implementation of the XU transport protocol
24 * @author Christian Grothoff
25 * @author Nathan Evans
26 * @author Matthias Wachs
28 #ifndef PLUGIN_TRANSPORT_XU_H
29 #define PLUGIN_TRANSPORT_XU_H
32 #include "gnunet_hello_lib.h"
33 #include "gnunet_util_lib.h"
34 #include "gnunet_fragmentation_lib.h"
35 #include "gnunet_protocols.h"
36 #include "gnunet_resolver_service.h"
37 #include "gnunet_signatures.h"
38 #include "gnunet_constants.h"
39 #include "gnunet_statistics_service.h"
40 #include "gnunet_transport_service.h"
41 #include "gnunet_transport_plugin.h"
42 #include "transport.h"
44 #define LOG(kind,...) GNUNET_log_from (kind, "transport-xu", __VA_ARGS__)
46 #define PLUGIN_NAME "xu"
48 #define DEBUG_XU GNUNET_NO
50 #define DEBUG_XU_BROADCASTING GNUNET_NO
53 * MTU for fragmentation subsystem. Should be conservative since
54 * all communicating peers MUST work with this MTU.
59 GNUNET_NETWORK_STRUCT_BEGIN
61 * Network format for IPv4 addresses.
66 * Optional options and flags for this address
68 uint32_t options GNUNET_PACKED;
71 * IPv4 address, in network byte order.
73 uint32_t ipv4_addr GNUNET_PACKED;
76 * Port number, in network byte order.
78 uint16_t u4_port GNUNET_PACKED;
83 * Network format for IPv6 addresses.
88 * Optional options and flags for this address
90 uint32_t options GNUNET_PACKED;
95 struct in6_addr ipv6_addr GNUNET_PACKED;
98 * Port number, in network byte order.
100 uint16_t u6_port GNUNET_PACKED;
102 GNUNET_NETWORK_STRUCT_END
105 * Either an IPv4 or IPv6 XU address. Note that without a "length",
106 * one cannot tell which one of the two types this address represents.
113 struct IPv4XuAddress v4;
118 struct IPv6XuAddress v6;
123 * Information we track for each message in the queue.
125 struct XU_MessageWrapper;
129 * Closure for #append_port().
131 struct PrettyPrinterContext;
135 * Encapsulation of all of the state of the plugin.
143 struct GNUNET_TRANSPORT_PluginEnvironment *env;
146 * Session of peers with whom we are currently connected,
147 * map of peer identity to `struct GNUNET_ATS_Session *`.
149 struct GNUNET_CONTAINER_MultiPeerMap *sessions;
152 * ID of select task for IPv4
154 struct GNUNET_SCHEDULER_Task *select_task_v4;
157 * ID of select task for IPv6
159 struct GNUNET_SCHEDULER_Task *select_task_v6;
162 * Address we were told to bind to exclusively (IPv4).
167 * Address we were told to bind to exclusively (IPv6).
172 * Handle to NAT traversal support.
174 struct GNUNET_NAT_Handle *nat;
177 * Handle to NAT traversal support.
179 struct GNUNET_NAT_STUN_Handle *stun;
182 * The read socket for IPv4
184 struct GNUNET_NETWORK_Handle *sockv4;
187 * The read socket for IPv6
189 struct GNUNET_NETWORK_Handle *sockv6;
192 * Running pretty printers: head
194 struct PrettyPrinterContext *ppc_dll_head;
197 * Running pretty printers: tail
199 struct PrettyPrinterContext *ppc_dll_tail;
202 * Function to call about session status changes.
204 GNUNET_TRANSPORT_SessionInfoCallback sic;
207 * Closure for @e sic.
212 * IPv6 multicast address
214 struct sockaddr_in6 ipv6_multicast_address;
219 struct GNUNET_TIME_Relative broadcast_interval;
222 * Bytes currently in buffer
224 int64_t bytes_in_buffer;
232 * Is IPv6 enabled: #GNUNET_YES or #GNUNET_NO
237 * Is IPv4 enabled: #GNUNET_YES or #GNUNET_NO
247 * Port we advertise on.
255 * Function called for a quick conversion of the binary address to
256 * a numeric address. Note that the caller must not free the
257 * address and that the next call to this function is allowed
258 * to override the address again.
261 * @param addr binary address (a `union XuAddress`)
262 * @param addrlen length of the @a addr
263 * @return string representing the same address
266 xu_address_to_string (void *cls,
271 /*#ifndef PLUGIN_TRANSPORT_XU_H*/
273 /* end of plugin_transport_xu.h */