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 /* Minimum time between to calculations*/
34 #define ATS_MIN_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 1)
35 #define ATS_EXEC_INTERVAL GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_SECONDS, 2)
36 #define ATS_MAX_EXEC_DURATION GNUNET_TIME_relative_multiply(GNUNET_TIME_UNIT_MILLISECONDS, 100)
37 #define ATS_MAX_ITERATIONS INT_MAX
39 #define DEBUG_TRANSPORT GNUNET_NO
40 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
41 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
44 * For how long do we allow unused bandwidth
45 * from the past to carry over into the future? (in seconds)
47 #define MAX_BANDWIDTH_CARRY_S 5
50 * How often do we (at most) do a full quota
51 * recalculation? (in ms)
53 #define MIN_QUOTA_REFRESH_TIME 2000
56 * Message from the transport service to the library
57 * asking to check if both processes agree about this
64 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
66 struct GNUNET_MessageHeader header;
69 * Should the 'self' field be checked?
74 * Identity we think we have. If it does not match, the
75 * receiver should print out an error message and disconnect.
77 struct GNUNET_PeerIdentity self;
83 * Message from the transport service to the library
84 * informing about neighbors.
86 struct ConnectInfoMessage
90 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
92 struct GNUNET_MessageHeader header;
95 * Number of ATS key-value pairs that follow this struct
96 * (excluding the 0-terminator).
98 uint32_t ats_count GNUNET_PACKED;
101 * Identity of the new neighbour.
103 struct GNUNET_PeerIdentity id;
106 * First of the ATS information blocks (we must have at least
107 * one due to the 0-termination requirement).
109 struct GNUNET_TRANSPORT_ATS_Information ats;
114 * Message from the transport service to the library
115 * informing about disconnects.
117 struct DisconnectInfoMessage
121 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
123 struct GNUNET_MessageHeader header;
126 * Reserved, always zero.
128 uint32_t reserved GNUNET_PACKED;
131 * Who got disconnected?
133 struct GNUNET_PeerIdentity peer;
138 * Message type for sending a request connect message
139 * to the transport service. Must be done before transport
140 * api will allow messages to be queued/sent to transport
141 * service for transmission to a peer.
143 struct TransportRequestConnectMessage
148 struct GNUNET_MessageHeader header;
151 * Identity of the peer we would like to connect to.
153 struct GNUNET_PeerIdentity peer;
157 * Message used to set a particular bandwidth quota. Send TO the
158 * service to set an incoming quota, send FROM the service to update
161 struct QuotaSetMessage
165 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
167 struct GNUNET_MessageHeader header;
172 struct GNUNET_BANDWIDTH_Value32NBO quota;
175 * About which peer are we talking here?
177 struct GNUNET_PeerIdentity peer;
183 * Message used to notify the transport API about a message
184 * received from the network. The actual message follows.
186 struct InboundMessage
190 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
192 struct GNUNET_MessageHeader header;
197 uint32_t reserved GNUNET_PACKED;
200 * Number of ATS key-value pairs that follow this struct
201 * (excluding the 0-terminator).
203 uint32_t ats_count GNUNET_PACKED;
206 * Which peer sent the message?
208 struct GNUNET_PeerIdentity peer;
211 * First of the ATS information blocks (we must have at least
212 * one due to the 0-termination requirement).
214 struct GNUNET_TRANSPORT_ATS_Information ats;
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_AbsoluteNBO 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 */
317 * Change in blacklisting (either request or notification,
318 * depending on which direction it is going).
320 struct BlacklistMessage
324 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
325 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
327 struct GNUNET_MessageHeader header;
330 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
333 uint32_t is_allowed GNUNET_PACKED;
336 * Which peer is being blacklisted or queried?
338 struct GNUNET_PeerIdentity peer;
343 /* end of transport.h */