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;
78 * Should the 'self' field be checked?
83 * Identity we think we have. If it does not match, the
84 * receiver should print out an error message and disconnect.
86 struct GNUNET_PeerIdentity self;
92 * Message from the transport service to the library
93 * informing about neighbors.
95 struct ConnectInfoMessage
99 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
101 struct GNUNET_MessageHeader header;
104 * Number of ATS key-value pairs that follow this struct
105 * (excluding the 0-terminator).
107 uint32_t ats_count GNUNET_PACKED;
110 * Identity of the new neighbour.
112 struct GNUNET_PeerIdentity id;
117 * Message from the transport service to the library
118 * informing about disconnects.
120 struct DisconnectInfoMessage
124 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
126 struct GNUNET_MessageHeader header;
129 * Reserved, always zero.
131 uint32_t reserved GNUNET_PACKED;
134 * Who got disconnected?
136 struct GNUNET_PeerIdentity peer;
141 * Message type for sending a request connect message
142 * to the transport service. Must be done before transport
143 * api will allow messages to be queued/sent to transport
144 * service for transmission to a peer.
146 struct TransportRequestConnectMessage
151 struct GNUNET_MessageHeader header;
159 * Identity of the peer we would like to connect to.
161 struct GNUNET_PeerIdentity peer;
165 * Message used to set a particular bandwidth quota. Sent TO the
166 * service to set an incoming quota, sent FROM the service to update
169 struct QuotaSetMessage
173 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
175 struct GNUNET_MessageHeader header;
180 struct GNUNET_BANDWIDTH_Value32NBO quota;
183 * About which peer are we talking here?
185 struct GNUNET_PeerIdentity peer;
191 * Message used to notify the transport API about a message
192 * received from the network. The actual message follows.
194 struct InboundMessage
198 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
200 struct GNUNET_MessageHeader header;
203 * Number of ATS key-value pairs that follow this struct
204 * (excluding the 0-terminator).
206 uint32_t ats_count GNUNET_PACKED;
209 * Which peer sent the message?
211 struct GNUNET_PeerIdentity peer;
217 * Message used to notify the transport API that it can
218 * send another message to the transport service.
224 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
226 struct GNUNET_MessageHeader header;
229 * GNUNET_OK if the transmission succeeded,
230 * GNUNET_SYSERR if it failed (i.e. network disconnect);
231 * in either case, it is now OK for this client to
232 * send us another message for the given peer.
234 uint32_t success GNUNET_PACKED;
239 struct GNUNET_TIME_RelativeNBO latency;
242 * Which peer can send more now?
244 struct GNUNET_PeerIdentity peer;
250 * Message used to notify the transport service about a message
251 * to be transmitted to another peer. The actual message follows.
253 struct OutboundMessage
257 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
259 struct GNUNET_MessageHeader header;
264 uint32_t priority GNUNET_PACKED;
269 struct GNUNET_TIME_RelativeNBO timeout;
272 * Which peer should receive the message?
274 struct GNUNET_PeerIdentity peer;
280 * Message from the library to the transport service
281 * asking for converting a transport address to a
282 * human-readable UTF-8 string.
284 struct AddressLookupMessage
288 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
290 struct GNUNET_MessageHeader header;
293 * Should the conversion use numeric IP addresses (otherwise
294 * a reverse DNS lookup is OK -- if applicable).
296 int32_t numeric_only GNUNET_PACKED;
299 * timeout to give up.
301 struct GNUNET_TIME_RelativeNBO timeout;
304 * Length of the (binary) address in bytes, in big-endian.
306 uint32_t addrlen GNUNET_PACKED;
308 /* followed by 'addrlen' bytes of the actual address, then
309 * followed by the 0-terminated name of the transport */
314 * Message from the library to the transport service
315 * asking for human readable addresses known for a peer.
317 struct PeerAddressLookupMessage
320 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
322 struct GNUNET_MessageHeader header;
330 * timeout to give up. FIXME: remove in the future.
332 struct GNUNET_TIME_RelativeNBO timeout;
335 * The identity of the peer to look up.
337 struct GNUNET_PeerIdentity peer;
342 * Message from the library to the transport service
343 * asking for binary addresses known for a peer.
345 struct AddressIterateMessage
348 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
350 struct GNUNET_MessageHeader header;
358 * timeout to give up. FIXME: remove in the future
360 struct GNUNET_TIME_AbsoluteNBO timeout;
364 * Message from the library to the transport service
365 * asking for human readable addresses known for a peer.
367 struct AddressIterateResponseMessage
370 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY
372 struct GNUNET_MessageHeader header;
382 struct GNUNET_PeerIdentity peer;
387 uint32_t addrlen GNUNET_PACKED;
390 * length of the plugin name
392 uint32_t pluginlen GNUNET_PACKED;
397 * Change in blacklisting (either request or notification,
398 * depending on which direction it is going).
400 struct BlacklistMessage
404 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
405 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
407 struct GNUNET_MessageHeader header;
410 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
413 uint32_t is_allowed GNUNET_PACKED;
416 * Which peer is being blacklisted or queried?
418 struct GNUNET_PeerIdentity peer;
423 /* end of transport.h */