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 GNUNET_EXTRA_LOGGING
35 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_EXTRA_LOGGING
37 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_EXTRA_LOGGING
39 #define DEBUG_TRANSPORT_API GNUNET_EXTRA_LOGGING
42 * For how long do we allow unused bandwidth
43 * from the past to carry over into the future? (in seconds)
45 #define MAX_BANDWIDTH_CARRY_S 5
48 * How often do we (at most) do a full quota
49 * recalculation? (in ms)
51 #define MIN_QUOTA_REFRESH_TIME 2000
54 * Maximum frequency for re-evaluating latencies for all transport addresses.
56 #define LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
59 * Maximum frequency for re-evaluating latencies for connected addresses.
61 #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
64 * Message from the transport service to the library
65 * asking to check if both processes agree about this
72 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
74 struct GNUNET_MessageHeader header;
77 * Should the 'self' field be checked?
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;
114 * First of the ATS information blocks (we must have at least
115 * one due to the 0-termination requirement).
117 struct GNUNET_TRANSPORT_ATS_Information ats;
122 * Message from the transport service to the library
123 * informing about disconnects.
125 struct DisconnectInfoMessage
129 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
131 struct GNUNET_MessageHeader header;
134 * Reserved, always zero.
136 uint32_t reserved GNUNET_PACKED;
139 * Who got disconnected?
141 struct GNUNET_PeerIdentity peer;
146 * Message type for sending a request connect message
147 * to the transport service. Must be done before transport
148 * api will allow messages to be queued/sent to transport
149 * service for transmission to a peer.
151 struct TransportRequestConnectMessage
156 struct GNUNET_MessageHeader header;
164 * Identity of the peer we would like to connect to.
166 struct GNUNET_PeerIdentity peer;
170 * Message used to set a particular bandwidth quota. Sent TO the
171 * service to set an incoming quota, sent FROM the service to update
174 struct QuotaSetMessage
178 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
180 struct GNUNET_MessageHeader header;
185 struct GNUNET_BANDWIDTH_Value32NBO quota;
188 * About which peer are we talking here?
190 struct GNUNET_PeerIdentity peer;
196 * Message used to notify the transport API about a message
197 * received from the network. The actual message follows.
199 struct InboundMessage
203 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
205 struct GNUNET_MessageHeader header;
210 uint32_t reserved GNUNET_PACKED;
213 * Number of ATS key-value pairs that follow this struct
214 * (excluding the 0-terminator).
216 uint32_t ats_count GNUNET_PACKED;
219 * Which peer sent the message?
221 struct GNUNET_PeerIdentity peer;
224 * First of the ATS information blocks (we must have at least
225 * one due to the 0-termination requirement).
227 struct GNUNET_TRANSPORT_ATS_Information ats;
232 * Message used to notify the transport API that it can
233 * send another message to the transport service.
239 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
241 struct GNUNET_MessageHeader header;
244 * GNUNET_OK if the transmission succeeded,
245 * GNUNET_SYSERR if it failed (i.e. network disconnect);
246 * in either case, it is now OK for this client to
247 * send us another message for the given peer.
249 uint32_t success GNUNET_PACKED;
254 struct GNUNET_TIME_RelativeNBO latency;
257 * Which peer can send more now?
259 struct GNUNET_PeerIdentity peer;
265 * Message used to notify the transport service about a message
266 * to be transmitted to another peer. The actual message follows.
268 struct OutboundMessage
272 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
274 struct GNUNET_MessageHeader header;
279 uint32_t priority GNUNET_PACKED;
284 struct GNUNET_TIME_RelativeNBO timeout;
287 * Which peer should receive the message?
289 struct GNUNET_PeerIdentity peer;
295 * Message from the library to the transport service
296 * asking for converting a transport address to a
297 * human-readable UTF-8 string.
299 struct AddressLookupMessage
303 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
305 struct GNUNET_MessageHeader header;
308 * Should the conversion use numeric IP addresses (otherwise
309 * a reverse DNS lookup is OK -- if applicable).
311 int32_t numeric_only GNUNET_PACKED;
314 * timeout to give up.
316 struct GNUNET_TIME_RelativeNBO timeout;
319 * Length of the (binary) address in bytes, in big-endian.
321 uint32_t addrlen GNUNET_PACKED;
323 /* followed by 'addrlen' bytes of the actual address, then
324 * followed by the 0-terminated name of the transport */
329 * Message from the library to the transport service
330 * asking for human readable addresses known for a peer.
332 struct PeerAddressLookupMessage
335 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_PEER_ADDRESS_LOOKUP
337 struct GNUNET_MessageHeader header;
345 * timeout to give up. FIXME: remove in the future.
347 struct GNUNET_TIME_RelativeNBO timeout;
350 * The identity of the peer to look up.
352 struct GNUNET_PeerIdentity peer;
357 * Message from the library to the transport service
358 * asking for binary addresses known for a peer.
360 struct AddressIterateMessage
363 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_ITERATE
365 struct GNUNET_MessageHeader header;
373 * timeout to give up. FIXME: remove in the future
375 struct GNUNET_TIME_AbsoluteNBO timeout;
379 * Message from the library to the transport service
380 * asking for human readable addresses known for a peer.
382 struct AddressIterateResponseMessage
385 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_REPLY
387 struct GNUNET_MessageHeader header;
397 struct GNUNET_PeerIdentity peer;
402 uint32_t addrlen GNUNET_PACKED;
405 * length of the plugin name
407 uint32_t pluginlen GNUNET_PACKED;
412 * Change in blacklisting (either request or notification,
413 * depending on which direction it is going).
415 struct BlacklistMessage
419 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
420 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
422 struct GNUNET_MessageHeader header;
425 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
428 uint32_t is_allowed GNUNET_PACKED;
431 * Which peer is being blacklisted or queried?
433 struct GNUNET_PeerIdentity peer;
438 /* end of transport.h */