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)
65 * Message from the transport service to the library
66 * asking to check if both processes agree about this
73 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
75 struct GNUNET_MessageHeader header;
79 * 1: The 'self' field should be checked
80 * 2: this client is interested in payload traffic
85 * Identity we think we have. If it does not match, the
86 * receiver should print out an error message and disconnect.
88 struct GNUNET_PeerIdentity self;
94 * Message from the transport service to the library
95 * informing about neighbors.
97 struct ConnectInfoMessage
101 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
103 struct GNUNET_MessageHeader header;
106 * Number of ATS key-value pairs that follow this struct
107 * (excluding the 0-terminator).
109 uint32_t ats_count GNUNET_PACKED;
112 * Identity of the new neighbour.
114 struct GNUNET_PeerIdentity id;
119 * Message from the transport service to the library
120 * informing about disconnects.
122 struct DisconnectInfoMessage
126 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
128 struct GNUNET_MessageHeader header;
131 * Reserved, always zero.
133 uint32_t reserved GNUNET_PACKED;
136 * Who got disconnected?
138 struct GNUNET_PeerIdentity peer;
143 * Message type for sending a request connect message
144 * to the transport service. Must be done before transport
145 * api will allow messages to be queued/sent to transport
146 * service for transmission to a peer.
148 struct TransportRequestConnectMessage
153 struct GNUNET_MessageHeader header;
161 * Identity of the peer we would like to connect to.
163 struct GNUNET_PeerIdentity peer;
167 * Message used to set a particular bandwidth quota. Sent TO the
168 * service to set an incoming quota, sent FROM the service to update
171 struct QuotaSetMessage
175 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
177 struct GNUNET_MessageHeader header;
182 struct GNUNET_BANDWIDTH_Value32NBO quota;
185 * About which peer are we talking here?
187 struct GNUNET_PeerIdentity peer;
193 * Message used to notify the transport API about a message
194 * received from the network. The actual message follows.
196 struct InboundMessage
200 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
202 struct GNUNET_MessageHeader header;
205 * Number of ATS key-value pairs that follow this struct
206 * (excluding the 0-terminator).
208 uint32_t ats_count GNUNET_PACKED;
211 * Which peer sent the message?
213 struct GNUNET_PeerIdentity peer;
219 * Message used to notify the transport API that it can
220 * send another message to the transport service.
226 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
228 struct GNUNET_MessageHeader header;
231 * GNUNET_OK if the transmission succeeded,
232 * GNUNET_SYSERR if it failed (i.e. network disconnect);
233 * in either case, it is now OK for this client to
234 * send us another message for the given peer.
236 uint32_t success GNUNET_PACKED;
241 struct GNUNET_TIME_RelativeNBO latency;
244 * Which peer can send more now?
246 struct GNUNET_PeerIdentity peer;
252 * Message used to notify the transport service about a message
253 * to be transmitted to another peer. The actual message follows.
255 struct OutboundMessage
259 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
261 struct GNUNET_MessageHeader header;
266 uint32_t priority GNUNET_PACKED;
271 struct GNUNET_TIME_RelativeNBO timeout;
274 * Which peer should receive the message?
276 struct GNUNET_PeerIdentity peer;
282 * Message from the library to the transport service
283 * asking for converting a transport address to a
284 * human-readable UTF-8 string.
286 struct AddressLookupMessage
290 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
292 struct GNUNET_MessageHeader header;
295 * Should the conversion use numeric IP addresses (otherwise
296 * a reverse DNS lookup is OK -- if applicable).
298 int32_t numeric_only GNUNET_PACKED;
301 * timeout to give up.
303 struct GNUNET_TIME_RelativeNBO timeout;
306 * Length of the (binary) address in bytes, in big-endian.
308 uint32_t addrlen GNUNET_PACKED;
310 /* followed by 'addrlen' bytes of the actual address, then
311 * followed by the 0-terminated name of the transport */
316 * Message from the library to the transport service
317 * asking for human readable addresses known for a peer.
319 struct PeerAddressLookupMessage
322 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
324 struct GNUNET_MessageHeader header;
332 * timeout to give up. FIXME: remove in the future.
334 struct GNUNET_TIME_RelativeNBO timeout;
337 * The identity of the peer to look up.
339 struct GNUNET_PeerIdentity peer;
344 * Message from the library to the transport service
345 * asking for binary addresses known for a peer.
347 struct AddressIterateMessage
350 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
352 struct GNUNET_MessageHeader header;
360 * timeout to give up. FIXME: remove in the future
362 struct GNUNET_TIME_AbsoluteNBO timeout;
366 * Message from the library to the transport service
367 * asking for human readable addresses known for a peer.
369 struct AddressIterateResponseMessage
372 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY
374 struct GNUNET_MessageHeader header;
384 struct GNUNET_PeerIdentity peer;
389 uint32_t addrlen GNUNET_PACKED;
392 * length of the plugin name
394 uint32_t pluginlen GNUNET_PACKED;
399 * Change in blacklisting (either request or notification,
400 * depending on which direction it is going).
402 struct BlacklistMessage
406 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
407 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
409 struct GNUNET_MessageHeader header;
412 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
415 uint32_t is_allowed GNUNET_PACKED;
418 * Which peer is being blacklisted or queried?
420 struct GNUNET_PeerIdentity peer;
425 /* end of transport.h */