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
36 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_EXTRA_LOGGING
38 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_EXTRA_LOGGING
40 #define DEBUG_TRANSPORT_API GNUNET_EXTRA_LOGGING
43 * For how long do we allow unused bandwidth
44 * from the past to carry over into the future? (in seconds)
46 #define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S
49 * How often do we (at most) do a full quota
50 * recalculation? (in ms)
52 #define MIN_QUOTA_REFRESH_TIME 2000
55 * Maximum frequency for re-evaluating latencies for all transport addresses.
57 #define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
60 * Maximum frequency for re-evaluating latencies for connected addresses.
62 #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
64 GNUNET_NETWORK_STRUCT_BEGIN
67 * Message from the transport service to the library
68 * asking to check if both processes agree about this
75 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
77 struct GNUNET_MessageHeader header;
81 * 1: The 'self' field should be checked
82 * 2: this client is interested in payload traffic
87 * Identity we think we have. If it does not match, the
88 * receiver should print out an error message and disconnect.
90 struct GNUNET_PeerIdentity self;
96 * Message from the transport service to the library
97 * informing about neighbors.
99 struct ConnectInfoMessage
103 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
105 struct GNUNET_MessageHeader header;
108 * Number of ATS key-value pairs that follow this struct
109 * (excluding the 0-terminator).
111 uint32_t ats_count GNUNET_PACKED;
114 * Identity of the new neighbour.
116 struct GNUNET_PeerIdentity id;
121 * Message from the transport service to the library
122 * informing about disconnects.
124 struct DisconnectInfoMessage
128 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
130 struct GNUNET_MessageHeader header;
133 * Reserved, always zero.
135 uint32_t reserved GNUNET_PACKED;
138 * Who got disconnected?
140 struct GNUNET_PeerIdentity peer;
145 * Message type for sending a request connect message
146 * to the transport service. Must be done before transport
147 * api will allow messages to be queued/sent to transport
148 * service for transmission to a peer.
150 struct TransportRequestConnectMessage
155 struct GNUNET_MessageHeader header;
163 * Identity of the peer we would like to connect to.
165 struct GNUNET_PeerIdentity peer;
169 * Message used to set a particular bandwidth quota. Sent TO the
170 * service to set an incoming quota, sent FROM the service to update
173 struct QuotaSetMessage
177 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
179 struct GNUNET_MessageHeader header;
184 struct GNUNET_BANDWIDTH_Value32NBO quota;
187 * About which peer are we talking here?
189 struct GNUNET_PeerIdentity peer;
195 * Message used to notify the transport API about a message
196 * received from the network. The actual message follows.
198 struct InboundMessage
202 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
204 struct GNUNET_MessageHeader header;
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;
221 * Message used to notify the transport API that it can
222 * send another message to the transport service.
228 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
230 struct GNUNET_MessageHeader header;
233 * GNUNET_OK if the transmission succeeded,
234 * GNUNET_SYSERR if it failed (i.e. network disconnect);
235 * in either case, it is now OK for this client to
236 * send us another message for the given peer.
238 uint32_t success GNUNET_PACKED;
243 struct GNUNET_TIME_RelativeNBO latency;
246 * Which peer can send more now?
248 struct GNUNET_PeerIdentity peer;
254 * Message used to notify the transport service about a message
255 * to be transmitted to another peer. The actual message follows.
257 struct OutboundMessage
261 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
263 struct GNUNET_MessageHeader header;
268 uint32_t priority GNUNET_PACKED;
273 struct GNUNET_TIME_RelativeNBO timeout;
276 * Which peer should receive the message?
278 struct GNUNET_PeerIdentity peer;
284 * Message from the library to the transport service
285 * asking for converting a transport address to a
286 * human-readable UTF-8 string.
288 struct AddressLookupMessage
292 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
294 struct GNUNET_MessageHeader header;
297 * Should the conversion use numeric IP addresses (otherwise
298 * a reverse DNS lookup is OK -- if applicable).
300 int16_t numeric_only GNUNET_PACKED;
303 * Length of the (binary) address in bytes, in big-endian.
305 uint16_t addrlen GNUNET_PACKED;
308 * timeout to give up.
310 struct GNUNET_TIME_RelativeNBO timeout;
312 /* followed by 'addrlen' bytes of the actual address, then
313 * followed by the 0-terminated name of the transport */
318 * Message from the library to the transport service
319 * asking for human readable addresses known for a peer.
321 struct PeerAddressLookupMessage
324 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
326 struct GNUNET_MessageHeader header;
334 * timeout to give up. FIXME: remove in the future.
336 struct GNUNET_TIME_RelativeNBO timeout;
339 * The identity of the peer to look up.
341 struct GNUNET_PeerIdentity peer;
346 * Message from the library to the transport service
347 * asking for binary addresses known for a peer.
349 struct AddressIterateMessage
352 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
354 struct GNUNET_MessageHeader header;
357 * One shot call or continous replies?
362 * timeout to give up. FIXME: remove in the future
364 struct GNUNET_TIME_AbsoluteNBO timeout;
367 * The identity of the peer to look up.
369 struct GNUNET_PeerIdentity peer;
375 * Message from the transport service to the library
376 * containing binary addresses known for a peer.
378 * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
380 struct AddressIterateResponseMessage
383 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE_RESPONSE
385 struct GNUNET_MessageHeader header;
395 struct GNUNET_PeerIdentity peer;
400 uint32_t addrlen GNUNET_PACKED;
403 * length of the plugin name
405 uint32_t pluginlen GNUNET_PACKED;
411 * Change in blacklisting (either request or notification,
412 * depending on which direction it is going).
414 struct BlacklistMessage
418 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
419 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
421 struct GNUNET_MessageHeader header;
424 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
427 uint32_t is_allowed GNUNET_PACKED;
430 * Which peer is being blacklisted or queried?
432 struct GNUNET_PeerIdentity peer;
435 GNUNET_NETWORK_STRUCT_END
437 /* end of transport.h */