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 2, 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_NO
36 * For how long do we allow unused bandwidth
37 * from the past to carry over into the future? (in ms)
39 #define MAX_BANDWIDTH_CARRY 5000
42 * How often do we (at most) do a full quota
43 * recalculation? (in ms)
45 #define MIN_QUOTA_REFRESH_TIME 2000
48 * Message from the transport service to the library
49 * informing about neighbors.
51 struct ConnectInfoMessage
55 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
57 struct GNUNET_MessageHeader header;
60 * Current quota for outbound traffic in bytes/ms.
61 * (should be equal to system default)
63 uint32_t quota_out GNUNET_PACKED;
68 struct GNUNET_TIME_RelativeNBO latency;
71 * Transport distance metric (i.e. hops for DV)
76 * Identity of the new neighbour.
78 struct GNUNET_PeerIdentity id;
84 * Message from the transport service to the library
85 * informing about disconnects.
87 struct DisconnectInfoMessage
91 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
93 struct GNUNET_MessageHeader header;
96 * Reserved, always zero.
98 uint32_t reserved GNUNET_PACKED;
101 * Who got disconnected?
103 struct GNUNET_PeerIdentity peer;
109 * Message used to set a particular bandwidth quota. Send
110 * TO the service to set an incoming quota, send FROM the
111 * service to update an outgoing quota.
113 struct QuotaSetMessage
117 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
119 struct GNUNET_MessageHeader header;
122 * Quota in bytes per ms, 0 to drop everything;
123 * in network byte order.
125 uint32_t quota_in GNUNET_PACKED;
128 * About which peer are we talking here?
130 struct GNUNET_PeerIdentity peer;
136 * Message used to ask the transport service to connect
137 * to a particular peer.
139 struct TryConnectMessage
143 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT.
145 struct GNUNET_MessageHeader header;
150 uint32_t reserved GNUNET_PACKED;
153 * About which peer are we talking here?
155 struct GNUNET_PeerIdentity peer;
160 * Message used to notify the transport API about a message
161 * received from the network. The actual message follows.
163 struct InboundMessage
167 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
169 struct GNUNET_MessageHeader header;
174 uint32_t reserved GNUNET_PACKED;
179 struct GNUNET_TIME_RelativeNBO latency;
182 * Which peer sent the message?
184 struct GNUNET_PeerIdentity peer;
195 * Message used to notify the transport API that it can
196 * send another message to the transport service.
202 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
204 struct GNUNET_MessageHeader header;
207 * GNUNET_OK if the transmission succeeded,
208 * GNUNET_SYSERR if it failed (i.e. network disconnect);
209 * in either case, it is now OK for this client to
210 * send us another message for the given peer.
212 uint32_t success GNUNET_PACKED;
215 * Which peer can send more now?
217 struct GNUNET_PeerIdentity peer;
223 * Message used to notify the transport service about a message
224 * to be transmitted to another peer. The actual message follows.
226 struct OutboundMessage
230 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
232 struct GNUNET_MessageHeader header;
237 uint32_t priority GNUNET_PACKED;
240 * Which peer should receive the message?
242 struct GNUNET_PeerIdentity peer;
248 * Message from the library to the transport service
249 * asking for converting a transport address to a
250 * human-readable UTF-8 string.
252 struct AddressLookupMessage
256 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
258 struct GNUNET_MessageHeader header;
261 * Should the conversion use numeric IP addresses (otherwise
262 * a reverse DNS lookup is OK -- if applicable).
264 int32_t numeric_only GNUNET_PACKED;
267 * timeout to give up.
269 struct GNUNET_TIME_AbsoluteNBO timeout;
272 * Length of the (binary) address in bytes, in big-endian.
274 uint32_t addrlen GNUNET_PACKED;
276 /* followed by 'addrlen' bytes of the actual address, then
277 followed by the 0-terminated name of the transport */
283 * Change in blacklisting (either request or notification,
284 * depending on which direction it is going).
286 struct BlacklistMessage
290 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST
292 struct GNUNET_MessageHeader header;
295 * Reserved (for alignment).
297 uint32_t reserved GNUNET_PACKED;
300 * Which peer is being blacklisted (or has seen its
301 * blacklisting expire)?
303 struct GNUNET_PeerIdentity peer;
306 * Until what time is this peer blacklisted (zero for
307 * no longer blacklisted).
309 struct GNUNET_TIME_AbsoluteNBO until;
314 /* end of transport.h */