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_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 * asking to check if both processes agree about this
58 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
60 struct GNUNET_MessageHeader header;
63 * Should the 'self' field be checked?
68 * Identity we think we have. If it does not match, the
69 * receiver should print out an error message and disconnect.
71 struct GNUNET_PeerIdentity self;
77 * Message from the transport service to the library
78 * informing about neighbors.
80 struct ConnectInfoMessage
84 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
86 struct GNUNET_MessageHeader header;
89 * Transport distance metric (i.e. hops for DV)
96 struct GNUNET_TIME_RelativeNBO latency;
99 * Identity of the new neighbour.
101 struct GNUNET_PeerIdentity id;
107 * Message from the transport service to the library
108 * informing about disconnects.
110 struct DisconnectInfoMessage
114 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
116 struct GNUNET_MessageHeader header;
119 * Reserved, always zero.
121 uint32_t reserved GNUNET_PACKED;
124 * Who got disconnected?
126 struct GNUNET_PeerIdentity peer;
131 * Message type for sending a request connect message
132 * to the transport service. Must be done before transport
133 * api will allow messages to be queued/sent to transport
134 * service for transmission to a peer.
136 struct TransportRequestConnectMessage
141 struct GNUNET_MessageHeader header;
144 * Identity of the peer we would like to connect to.
146 struct GNUNET_PeerIdentity peer;
150 * Message used to set a particular bandwidth quota. Send TO the
151 * service to set an incoming quota, send FROM the service to update
154 struct QuotaSetMessage
158 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
160 struct GNUNET_MessageHeader header;
165 struct GNUNET_BANDWIDTH_Value32NBO quota;
168 * About which peer are we talking here?
170 struct GNUNET_PeerIdentity peer;
176 * Message used to notify the transport API about a message
177 * received from the network. The actual message follows.
179 struct InboundMessage
183 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
185 struct GNUNET_MessageHeader header;
190 uint32_t reserved GNUNET_PACKED;
195 struct GNUNET_TIME_RelativeNBO latency;
198 * Which peer sent the message?
200 struct GNUNET_PeerIdentity peer;
211 * Message used to notify the transport API that it can
212 * send another message to the transport service.
218 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
220 struct GNUNET_MessageHeader header;
223 * GNUNET_OK if the transmission succeeded,
224 * GNUNET_SYSERR if it failed (i.e. network disconnect);
225 * in either case, it is now OK for this client to
226 * send us another message for the given peer.
228 uint32_t success GNUNET_PACKED;
233 struct GNUNET_TIME_RelativeNBO latency;
236 * Which peer can send more now?
238 struct GNUNET_PeerIdentity peer;
244 * Message used to notify the transport service about a message
245 * to be transmitted to another peer. The actual message follows.
247 struct OutboundMessage
251 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
253 struct GNUNET_MessageHeader header;
258 uint32_t priority GNUNET_PACKED;
263 struct GNUNET_TIME_RelativeNBO timeout;
266 * Which peer should receive the message?
268 struct GNUNET_PeerIdentity peer;
274 * Message from the library to the transport service
275 * asking for converting a transport address to a
276 * human-readable UTF-8 string.
278 struct AddressLookupMessage
282 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
284 struct GNUNET_MessageHeader header;
287 * Should the conversion use numeric IP addresses (otherwise
288 * a reverse DNS lookup is OK -- if applicable).
290 int32_t numeric_only GNUNET_PACKED;
293 * timeout to give up.
295 struct GNUNET_TIME_AbsoluteNBO timeout;
298 * Length of the (binary) address in bytes, in big-endian.
300 uint32_t addrlen GNUNET_PACKED;
302 /* followed by 'addrlen' bytes of the actual address, then
303 followed by the 0-terminated name of the transport */
309 * Change in blacklisting (either request or notification,
310 * depending on which direction it is going).
312 struct BlacklistMessage
316 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
317 * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
319 struct GNUNET_MessageHeader header;
322 * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
325 uint32_t is_allowed GNUNET_PACKED;
328 * Which peer is being blacklisted or queried?
330 struct GNUNET_PeerIdentity peer;
335 /* end of transport.h */