2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/transport.h
23 * @brief common internal definitions for transport service
24 * @author Christian Grothoff
29 #include "gnunet_crypto_lib.h"
30 #include "gnunet_time_lib.h"
31 #include "gnunet_transport_service.h"
33 /* Minimum time between to calculations*/
34 #define ATS_MIN_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 15)
35 #define ATS_EXEC_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 30)
36 #define ATS_MAX_EXEC_DURATION GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 3)
37 #define ATS_MAX_ITERATIONS INT_MAX
39 #define DEBUG_TRANSPORT GNUNET_NO
41 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
43 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
46 * For how long do we allow unused bandwidth
47 * from the past to carry over into the future? (in seconds)
49 #define MAX_BANDWIDTH_CARRY_S 5
52 * How often do we (at most) do a full quota
53 * recalculation? (in ms)
55 #define MIN_QUOTA_REFRESH_TIME 2000
58 * Message from the transport service to the library
59 * asking to check if both processes agree about this
66 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
68 struct GNUNET_MessageHeader header;
71 * Should the 'self' field be checked?
76 * Identity we think we have. If it does not match, the
77 * receiver should print out an error message and disconnect.
79 struct GNUNET_PeerIdentity self;
85 * Message from the transport service to the library
86 * informing about neighbors.
88 struct ConnectInfoMessage
92 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
94 struct GNUNET_MessageHeader header;
97 * Number of ATS key-value pairs that follow this struct
98 * (excluding the 0-terminator).
100 uint32_t ats_count GNUNET_PACKED;
103 * Identity of the new neighbour.
105 struct GNUNET_PeerIdentity id;
108 * First of the ATS information blocks (we must have at least
109 * one due to the 0-termination requirement).
111 struct GNUNET_TRANSPORT_ATS_Information ats;
116 * Message from the transport service to the library
117 * informing about disconnects.
119 struct DisconnectInfoMessage
123 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
125 struct GNUNET_MessageHeader header;
128 * Reserved, always zero.
130 uint32_t reserved GNUNET_PACKED;
133 * Who got disconnected?
135 struct GNUNET_PeerIdentity peer;
140 * Message type for sending a request connect message
141 * to the transport service. Must be done before transport
142 * api will allow messages to be queued/sent to transport
143 * service for transmission to a peer.
145 struct TransportRequestConnectMessage
150 struct GNUNET_MessageHeader header;
158 * Identity of the peer we would like to connect to.
160 struct GNUNET_PeerIdentity peer;
164 * Message used to set a particular bandwidth quota. Send TO the
165 * service to set an incoming quota, send FROM the service to update
168 struct QuotaSetMessage
172 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
174 struct GNUNET_MessageHeader header;
179 struct GNUNET_BANDWIDTH_Value32NBO quota;
182 * About which peer are we talking here?
184 struct GNUNET_PeerIdentity peer;
190 * Message used to notify the transport API about a message
191 * received from the network. The actual message follows.
193 struct InboundMessage
197 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
199 struct GNUNET_MessageHeader header;
204 uint32_t reserved GNUNET_PACKED;
207 * Number of ATS key-value pairs that follow this struct
208 * (excluding the 0-terminator).
210 uint32_t ats_count GNUNET_PACKED;
213 * Which peer sent the message?
215 struct GNUNET_PeerIdentity peer;
218 * First of the ATS information blocks (we must have at least
219 * one due to the 0-termination requirement).
221 struct GNUNET_TRANSPORT_ATS_Information ats;
226 * Message used to notify the transport API that it can
227 * send another message to the transport service.
233 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
235 struct GNUNET_MessageHeader header;
238 * GNUNET_OK if the transmission succeeded,
239 * GNUNET_SYSERR if it failed (i.e. network disconnect);
240 * in either case, it is now OK for this client to
241 * send us another message for the given peer.
243 uint32_t success GNUNET_PACKED;
248 struct GNUNET_TIME_RelativeNBO latency;
251 * Which peer can send more now?
253 struct GNUNET_PeerIdentity peer;
259 * Message used to notify the transport service about a message
260 * to be transmitted to another peer. The actual message follows.
262 struct OutboundMessage
266 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
268 struct GNUNET_MessageHeader header;
273 uint32_t priority GNUNET_PACKED;
278 struct GNUNET_TIME_RelativeNBO timeout;
281 * Which peer should receive the message?
283 struct GNUNET_PeerIdentity peer;
289 * Message from the library to the transport service
290 * asking for converting a transport address to a
291 * human-readable UTF-8 string.
293 struct AddressLookupMessage
297 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
299 struct GNUNET_MessageHeader header;
302 * Should the conversion use numeric IP addresses (otherwise
303 * a reverse DNS lookup is OK -- if applicable).
305 int32_t numeric_only GNUNET_PACKED;
308 * timeout to give up.
310 struct GNUNET_TIME_AbsoluteNBO timeout;
313 * Length of the (binary) address in bytes, in big-endian.
315 uint32_t addrlen GNUNET_PACKED;
317 /* followed by 'addrlen' bytes of the actual address, then
318 followed by the 0-terminated name of the transport */
324 * Change in blacklisting (either request or notification,
325 * depending on which direction it is going).
327 struct BlacklistMessage
331 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
332 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
334 struct GNUNET_MessageHeader header;
337 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
340 uint32_t is_allowed GNUNET_PACKED;
343 * Which peer is being blacklisted or queried?
345 struct GNUNET_PeerIdentity peer;
350 /* end of transport.h */