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
34 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
35 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
38 * For how long do we allow unused bandwidth
39 * from the past to carry over into the future? (in seconds)
41 #define MAX_BANDWIDTH_CARRY_S 5
44 * How often do we (at most) do a full quota
45 * recalculation? (in ms)
47 #define MIN_QUOTA_REFRESH_TIME 2000
50 * Message from the transport service to the library
51 * informing about neighbors.
53 struct ConnectInfoMessage
57 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
59 struct GNUNET_MessageHeader header;
62 * Transport distance metric (i.e. hops for DV)
69 struct GNUNET_TIME_RelativeNBO latency;
72 * Identity of the new neighbour.
74 struct GNUNET_PeerIdentity id;
80 * Message from the transport service to the library
81 * informing about disconnects.
83 struct DisconnectInfoMessage
87 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
89 struct GNUNET_MessageHeader header;
92 * Reserved, always zero.
94 uint32_t reserved GNUNET_PACKED;
97 * Who got disconnected?
99 struct GNUNET_PeerIdentity peer;
105 * Message used to set a particular bandwidth quota. Send TO the
106 * service to set an incoming quota, send FROM the service to update
109 struct QuotaSetMessage
113 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
115 struct GNUNET_MessageHeader header;
120 struct GNUNET_BANDWIDTH_Value32NBO quota;
123 * About which peer are we talking here?
125 struct GNUNET_PeerIdentity peer;
131 * Message used to notify the transport API about a message
132 * received from the network. The actual message follows.
134 struct InboundMessage
138 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
140 struct GNUNET_MessageHeader header;
145 uint32_t reserved GNUNET_PACKED;
150 struct GNUNET_TIME_RelativeNBO latency;
153 * Which peer sent the message?
155 struct GNUNET_PeerIdentity peer;
166 * Message used to notify the transport API that it can
167 * send another message to the transport service.
173 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
175 struct GNUNET_MessageHeader header;
178 * GNUNET_OK if the transmission succeeded,
179 * GNUNET_SYSERR if it failed (i.e. network disconnect);
180 * in either case, it is now OK for this client to
181 * send us another message for the given peer.
183 uint32_t success GNUNET_PACKED;
188 struct GNUNET_TIME_RelativeNBO latency;
191 * Which peer can send more now?
193 struct GNUNET_PeerIdentity peer;
199 * Message used to notify the transport service about a message
200 * to be transmitted to another peer. The actual message follows.
202 struct OutboundMessage
206 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
208 struct GNUNET_MessageHeader header;
213 uint32_t priority GNUNET_PACKED;
218 struct GNUNET_TIME_RelativeNBO timeout;
221 * Which peer should receive the message?
223 struct GNUNET_PeerIdentity peer;
229 * Message from the library to the transport service
230 * asking for converting a transport address to a
231 * human-readable UTF-8 string.
233 struct AddressLookupMessage
237 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
239 struct GNUNET_MessageHeader header;
242 * Should the conversion use numeric IP addresses (otherwise
243 * a reverse DNS lookup is OK -- if applicable).
245 int32_t numeric_only GNUNET_PACKED;
248 * timeout to give up.
250 struct GNUNET_TIME_AbsoluteNBO timeout;
253 * Length of the (binary) address in bytes, in big-endian.
255 uint32_t addrlen GNUNET_PACKED;
257 /* followed by 'addrlen' bytes of the actual address, then
258 followed by the 0-terminated name of the transport */
264 * Change in blacklisting (either request or notification,
265 * depending on which direction it is going).
267 struct BlacklistMessage
271 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
272 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
274 struct GNUNET_MessageHeader header;
277 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
280 uint32_t is_allowed GNUNET_PACKED;
283 * Which peer is being blacklisted or queried?
285 struct GNUNET_PeerIdentity peer;
290 /* end of transport.h */