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"
32 #include "gnunet_constants.h"
34 #define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING
38 * For how long do we allow unused bandwidth
39 * from the past to carry over into the future? (in seconds)
41 #define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S
44 * How often do we (at most) do a full quota
45 * recalculation? (in ms)
47 #define MIN_QUOTA_REFRESH_TIME 2000
50 * Maximum frequency for re-evaluating latencies for all transport addresses.
52 #define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
55 * Maximum frequency for re-evaluating latencies for connected addresses.
57 #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
59 GNUNET_NETWORK_STRUCT_BEGIN
62 * Message from the transport service to the library
63 * asking to check if both processes agree about this
70 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
72 struct GNUNET_MessageHeader header;
76 * 1: The 'self' field should be checked
77 * 2: this client is interested in payload traffic
82 * Identity we think we have. If it does not match, the
83 * receiver should print out an error message and disconnect.
85 struct GNUNET_PeerIdentity self;
91 * Message from the transport service to the library
92 * informing about neighbors.
94 struct ConnectInfoMessage
98 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
100 struct GNUNET_MessageHeader header;
103 * Number of ATS key-value pairs that follow this struct
104 * (excluding the 0-terminator).
106 uint32_t ats_count GNUNET_PACKED;
109 * Identity of the new neighbour.
111 struct GNUNET_PeerIdentity id;
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. Sent TO the
165 * service to set an incoming quota, sent FROM the service to update
168 struct QuotaSetMessage
172 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
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;
202 * Number of ATS key-value pairs that follow this struct
203 * (excluding the 0-terminator).
205 uint32_t ats_count GNUNET_PACKED;
208 * Which peer sent the message?
210 struct GNUNET_PeerIdentity peer;
216 * Message used to notify the transport API that it can
217 * send another message to the transport service.
223 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
225 struct GNUNET_MessageHeader header;
228 * GNUNET_OK if the transmission succeeded,
229 * GNUNET_SYSERR if it failed (i.e. network disconnect);
230 * in either case, it is now OK for this client to
231 * send us another message for the given peer.
233 uint32_t success GNUNET_PACKED;
238 struct GNUNET_TIME_RelativeNBO latency;
241 * Which peer can send more now?
243 struct GNUNET_PeerIdentity peer;
249 * Message used to notify the transport service about a message
250 * to be transmitted to another peer. The actual message follows.
252 struct OutboundMessage
256 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
258 struct GNUNET_MessageHeader header;
263 uint32_t priority GNUNET_PACKED;
268 struct GNUNET_TIME_RelativeNBO timeout;
271 * Which peer should receive the message?
273 struct GNUNET_PeerIdentity peer;
279 * Message from the library to the transport service
280 * asking for converting a transport address to a
281 * human-readable UTF-8 string.
283 struct AddressLookupMessage
287 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
289 struct GNUNET_MessageHeader header;
292 * Should the conversion use numeric IP addresses (otherwise
293 * a reverse DNS lookup is OK -- if applicable).
295 int16_t numeric_only GNUNET_PACKED;
298 * Length of the (binary) address in bytes, in big-endian.
300 uint16_t addrlen GNUNET_PACKED;
303 * timeout to give up.
305 struct GNUNET_TIME_RelativeNBO timeout;
307 /* followed by 'addrlen' bytes of the actual address, then
308 * followed by the 0-terminated name of the transport */
313 * Message from the library to the transport service
314 * asking for human readable addresses known for a peer.
316 struct PeerAddressLookupMessage
319 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
321 struct GNUNET_MessageHeader header;
329 * timeout to give up. FIXME: remove in the future.
331 struct GNUNET_TIME_RelativeNBO timeout;
334 * The identity of the peer to look up.
336 struct GNUNET_PeerIdentity peer;
341 * Message from the library to the transport service
342 * asking for binary addresses known for a peer.
344 struct AddressIterateMessage
347 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
349 struct GNUNET_MessageHeader header;
352 * One shot call or continous replies?
357 * timeout to give up. FIXME: remove in the future
359 struct GNUNET_TIME_AbsoluteNBO timeout;
362 * The identity of the peer to look up.
364 struct GNUNET_PeerIdentity peer;
370 * Message from the transport service to the library
371 * containing binary addresses known for a peer.
373 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
375 struct AddressIterateResponseMessage
378 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE
380 struct GNUNET_MessageHeader header;
390 struct GNUNET_PeerIdentity peer;
395 uint32_t addrlen GNUNET_PACKED;
398 * length of the plugin name
400 uint32_t pluginlen GNUNET_PACKED;
406 * Change in blacklisting (either request or notification,
407 * depending on which direction it is going).
409 struct BlacklistMessage
413 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
414 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
416 struct GNUNET_MessageHeader header;
419 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
422 uint32_t is_allowed GNUNET_PACKED;
425 * Which peer is being blacklisted or queried?
427 struct GNUNET_PeerIdentity peer;
430 GNUNET_NETWORK_STRUCT_END
432 /* end of transport.h */