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 #define DEBUG_TRANSPORT 3
35 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
37 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
40 * For how long do we allow unused bandwidth
41 * from the past to carry over into the future? (in seconds)
43 #define MAX_BANDWIDTH_CARRY_S 5
46 * How often do we (at most) do a full quota
47 * recalculation? (in ms)
49 #define MIN_QUOTA_REFRESH_TIME 2000
52 * Maximum frequency for re-evaluating latencies for all transport addresses.
54 #define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
57 * Maximum frequency for re-evaluating latencies for connected addresses.
59 #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
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;
75 * Should the 'self' field be checked?
80 * Identity we think we have. If it does not match, the
81 * receiver should print out an error message and disconnect.
83 struct GNUNET_PeerIdentity self;
89 * Message from the transport service to the library
90 * informing about neighbors.
92 struct ConnectInfoMessage
96 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
98 struct GNUNET_MessageHeader header;
101 * Number of ATS key-value pairs that follow this struct
102 * (excluding the 0-terminator).
104 uint32_t ats_count GNUNET_PACKED;
107 * Identity of the new neighbour.
109 struct GNUNET_PeerIdentity id;
112 * First of the ATS information blocks (we must have at least
113 * one due to the 0-termination requirement).
115 struct GNUNET_TRANSPORT_ATS_Information ats;
120 * Message from the transport service to the library
121 * informing about disconnects.
123 struct DisconnectInfoMessage
127 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
129 struct GNUNET_MessageHeader header;
132 * Reserved, always zero.
134 uint32_t reserved GNUNET_PACKED;
137 * Who got disconnected?
139 struct GNUNET_PeerIdentity peer;
144 * Message type for sending a request connect message
145 * to the transport service. Must be done before transport
146 * api will allow messages to be queued/sent to transport
147 * service for transmission to a peer.
149 struct TransportRequestConnectMessage
154 struct GNUNET_MessageHeader header;
162 * Identity of the peer we would like to connect to.
164 struct GNUNET_PeerIdentity peer;
168 * Message used to set a particular bandwidth quota. Sent TO the
169 * service to set an incoming quota, sent FROM the service to update
172 struct QuotaSetMessage
176 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
178 struct GNUNET_MessageHeader header;
183 struct GNUNET_BANDWIDTH_Value32NBO quota;
186 * About which peer are we talking here?
188 struct GNUNET_PeerIdentity peer;
194 * Message used to notify the transport API about a message
195 * received from the network. The actual message follows.
197 struct InboundMessage
201 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
203 struct GNUNET_MessageHeader header;
208 uint32_t reserved GNUNET_PACKED;
211 * Number of ATS key-value pairs that follow this struct
212 * (excluding the 0-terminator).
214 uint32_t ats_count GNUNET_PACKED;
217 * Which peer sent the message?
219 struct GNUNET_PeerIdentity peer;
222 * First of the ATS information blocks (we must have at least
223 * one due to the 0-termination requirement).
225 struct GNUNET_TRANSPORT_ATS_Information ats;
230 * Message used to notify the transport API that it can
231 * send another message to the transport service.
237 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
239 struct GNUNET_MessageHeader header;
242 * GNUNET_OK if the transmission succeeded,
243 * GNUNET_SYSERR if it failed (i.e. network disconnect);
244 * in either case, it is now OK for this client to
245 * send us another message for the given peer.
247 uint32_t success GNUNET_PACKED;
252 struct GNUNET_TIME_RelativeNBO latency;
255 * Which peer can send more now?
257 struct GNUNET_PeerIdentity peer;
263 * Message used to notify the transport service about a message
264 * to be transmitted to another peer. The actual message follows.
266 struct OutboundMessage
270 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
272 struct GNUNET_MessageHeader header;
277 uint32_t priority GNUNET_PACKED;
282 struct GNUNET_TIME_RelativeNBO timeout;
285 * Which peer should receive the message?
287 struct GNUNET_PeerIdentity peer;
293 * Message from the library to the transport service
294 * asking for converting a transport address to a
295 * human-readable UTF-8 string.
297 struct AddressLookupMessage
301 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
303 struct GNUNET_MessageHeader header;
306 * Should the conversion use numeric IP addresses (otherwise
307 * a reverse DNS lookup is OK -- if applicable).
309 int32_t numeric_only GNUNET_PACKED;
312 * timeout to give up.
314 struct GNUNET_TIME_RelativeNBO timeout;
317 * Length of the (binary) address in bytes, in big-endian.
319 uint32_t addrlen GNUNET_PACKED;
321 /* followed by 'addrlen' bytes of the actual address, then
322 followed by the 0-terminated name of the transport */
327 * Message from the library to the transport service
328 * asking for human readable addresses known for a peer.
330 struct PeerAddressLookupMessage
333 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
335 struct GNUNET_MessageHeader header;
343 * timeout to give up. FIXME: remove in the future.
345 struct GNUNET_TIME_RelativeNBO timeout;
348 * The identity of the peer to look up.
350 struct GNUNET_PeerIdentity peer;
355 * Message from the library to the transport service
356 * asking for human readable addresses known for a peer.
358 struct AddressIterateMessage
361 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
363 struct GNUNET_MessageHeader header;
371 * timeout to give up. FIXME: remove in the future
373 struct GNUNET_TIME_AbsoluteNBO timeout;
378 * Change in blacklisting (either request or notification,
379 * depending on which direction it is going).
381 struct BlacklistMessage
385 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
386 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
388 struct GNUNET_MessageHeader header;
391 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
394 uint32_t is_allowed GNUNET_PACKED;
397 * Which peer is being blacklisted or queried?
399 struct GNUNET_PeerIdentity peer;
404 /* end of transport.h */