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
26 #include "gnunet_crypto_lib.h"
27 #include "gnunet_time_lib.h"
28 #include "gnunet_transport_service.h"
30 #define DEBUG_TRANSPORT GNUNET_NO
33 * For how long do we allow unused bandwidth
34 * from the past to carry over into the future? (in ms)
36 #define MAX_BANDWIDTH_CARRY 5000
39 * How often do we (at most) do a full quota
40 * recalculation? (in ms)
42 #define MIN_QUOTA_REFRESH_TIME 2000
45 * Message from the transport service to the library
46 * informing about neighbors.
48 struct ConnectInfoMessage
52 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
54 struct GNUNET_MessageHeader header;
57 * Current quota for outbound traffic in bytes/ms.
58 * (should be equal to system default)
60 uint32_t quota_out GNUNET_PACKED;
65 struct GNUNET_TIME_RelativeNBO latency;
68 * Identity of the new neighbour.
70 struct GNUNET_PeerIdentity id;
76 * Message from the transport service to the library
77 * informing about disconnects.
79 struct DisconnectInfoMessage
83 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
85 struct GNUNET_MessageHeader header;
88 * Reserved, always zero.
90 uint32_t reserved GNUNET_PACKED;
93 * Who got disconnected?
95 struct GNUNET_PeerIdentity peer;
101 * Message used to set a particular bandwidth quota. Send
102 * TO the service to set an incoming quota, send FROM the
103 * service to update an outgoing quota.
105 struct QuotaSetMessage
109 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
111 struct GNUNET_MessageHeader header;
114 * Quota in bytes per ms, 0 to drop everything;
115 * in network byte order.
117 uint32_t quota_in GNUNET_PACKED;
120 * About which peer are we talking here?
122 struct GNUNET_PeerIdentity peer;
128 * Message used to ask the transport service to connect
129 * to a particular peer.
131 struct TryConnectMessage
135 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_TRY_CONNECT.
137 struct GNUNET_MessageHeader header;
142 uint32_t reserved GNUNET_PACKED;
145 * About which peer are we talking here?
147 struct GNUNET_PeerIdentity peer;
152 * Message used to notify the transport API about a message
153 * received from the network. The actual message follows.
155 struct InboundMessage
159 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
161 struct GNUNET_MessageHeader header;
166 uint32_t reserved GNUNET_PACKED;
171 struct GNUNET_TIME_RelativeNBO latency;
174 * Which peer sent the message?
176 struct GNUNET_PeerIdentity peer;
182 * Message used to notify the transport API that it can
183 * send another message to the transport service.
189 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
191 struct GNUNET_MessageHeader header;
194 * GNUNET_OK if the transmission succeeded,
195 * GNUNET_SYSERR if it failed (i.e. network disconnect);
196 * in either case, it is now OK for this client to
197 * send us another message for the given peer.
199 uint32_t success GNUNET_PACKED;
202 * Which peer can send more now?
204 struct GNUNET_PeerIdentity peer;
210 * Message used to notify the transport service about a message
211 * to be transmitted to another peer. The actual message follows.
213 struct OutboundMessage
217 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
219 struct GNUNET_MessageHeader header;
224 uint32_t priority GNUNET_PACKED;
227 * Which peer should receive the message?
229 struct GNUNET_PeerIdentity peer;
237 * Message from the library to the transport service
238 * asking for converting a transport address to a
239 * human-readable UTF-8 string.
241 struct AddressLookupMessage
245 * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
247 struct GNUNET_MessageHeader header;
250 * timeout to give up.
252 struct GNUNET_TIME_AbsoluteNBO timeout;
255 * Length of the (binary) address in bytes, in big-endian.
257 uint32_t addrlen GNUNET_PACKED;
259 /* followed by 'addrlen' bytes of the actual address, then
260 followed by the 0-terminated name of the transport */
264 /* end of transport.h */