src/transport/transport.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19 */
  20
  21 /**
  22  * @file transport/transport.h
  23  * @brief common internal definitions for transport service
  24  * @author Christian Grothoff
  25  */
  26 #ifndef TRANSPORT_H
  27 #define TRANSPORT_H
  28
  29 #include "gnunet_crypto_lib.h"
  30 #include "gnunet_time_lib.h"
  31 #include "gnunet_transport_service.h"
  32
  33 #define DEBUG_TRANSPORT GNUNET_NO
  34 #define DEBUG_TRANSPORT_TIMEOUT GNUNET_NO
  35 #define DEBUG_TRANSPORT_DISCONNECT GNUNET_NO
  36
  37 /**
  38  * For how long do we allow unused bandwidth
  39  * from the past to carry over into the future? (in seconds)
  40  */
  41 #define MAX_BANDWIDTH_CARRY_S 5
  42
  43 /**
  44  * How often do we (at most) do a full quota
  45  * recalculation? (in ms)
  46  */
  47 #define MIN_QUOTA_REFRESH_TIME 2000
  48
  49 /**
  50  * Message from the transport service to the library
  51  * asking to check if both processes agree about this
  52  * peers identity.
  53  */
  54 struct StartMessage
  55 {
  56
  57   /**
  58    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
  59    */
  60   struct GNUNET_MessageHeader header;
  61
  62   /**
  63    * Should the 'self' field be checked?
  64    */
  65   uint32_t do_check;
  66
  67   /**
  68    * Identity we think we have.  If it does not match, the
  69    * receiver should print out an error message and disconnect.
  70    */
  71   struct GNUNET_PeerIdentity self;
  72
  73 };
  74
  75
  76 /**
  77  * Message from the transport service to the library
  78  * informing about neighbors.
  79  */
  80 struct ConnectInfoMessage
  81 {
  82
  83   /**
  84    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
  85    */
  86   struct GNUNET_MessageHeader header;
  87
  88   /**
  89    * Number of ATS key-value pairs that follow this struct
  90    * (excluding the 0-terminator).
  91    */
  92   uint32_t ats_count GNUNET_PACKED;
  93
  94   /**
  95    * Identity of the new neighbour.
  96    */
  97   struct GNUNET_PeerIdentity id;
  98
  99   /**
 100    * First of the ATS information blocks (we must have at least
 101    * one due to the 0-termination requirement).
 102    */
 103   struct GNUNET_TRANSPORT_ATS_Information ats;
 104 };
 105
 106
 107 /**
 108  * Message from the transport service to the library
 109  * informing about disconnects.
 110  */
 111 struct DisconnectInfoMessage
 112 {
 113
 114   /**
 115    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
 116    */
 117   struct GNUNET_MessageHeader header;
 118
 119   /**
 120    * Reserved, always zero.
 121    */
 122   uint32_t reserved GNUNET_PACKED;
 123
 124   /**
 125    * Who got disconnected?
 126    */
 127   struct GNUNET_PeerIdentity peer;
 128
 129 };
 130
 131 /**
 132  * Message type for sending a request connect message
 133  * to the transport service.  Must be done before transport
 134  * api will allow messages to be queued/sent to transport
 135  * service for transmission to a peer.
 136  */
 137 struct TransportRequestConnectMessage
 138 {
 139   /**
 140    *  Message header
 141    */
 142   struct GNUNET_MessageHeader header;
 143
 144   /**
 145    * Identity of the peer we would like to connect to.
 146    */
 147   struct GNUNET_PeerIdentity peer;
 148 };
 149
 150 /**
 151  * Message used to set a particular bandwidth quota.  Send TO the
 152  * service to set an incoming quota, send FROM the service to update
 153  * an outgoing quota.
 154  */
 155 struct QuotaSetMessage
 156 {
 157
 158   /**
 159    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
 160    */
 161   struct GNUNET_MessageHeader header;
 162
 163   /**
 164    * Quota.
 165    */
 166   struct GNUNET_BANDWIDTH_Value32NBO quota;
 167
 168   /**
 169    * About which peer are we talking here?
 170    */
 171   struct GNUNET_PeerIdentity peer;
 172
 173 };
 174
 175
 176 /**
 177  * Message used to notify the transport API about a message
 178  * received from the network.  The actual message follows.
 179  */
 180 struct InboundMessage
 181 {
 182
 183   /**
 184    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
 185    */
 186   struct GNUNET_MessageHeader header;
 187
 188   /**
 189    * Always zero.
 190    */
 191   uint32_t reserved GNUNET_PACKED;
 192
 193   /**
 194    * Number of ATS key-value pairs that follow this struct
 195    * (excluding the 0-terminator).
 196    */
 197   uint32_t ats_count GNUNET_PACKED;
 198
 199   /**
 200    * Which peer sent the message?
 201    */
 202   struct GNUNET_PeerIdentity peer;
 203
 204   /**
 205    * First of the ATS information blocks (we must have at least
 206    * one due to the 0-termination requirement).
 207    */
 208   struct GNUNET_TRANSPORT_ATS_Information ats;
 209 };
 210
 211
 212 /**
 213  * Message used to notify the transport API that it can
 214  * send another message to the transport service.
 215  */
 216 struct SendOkMessage
 217 {
 218
 219   /**
 220    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
 221    */
 222   struct GNUNET_MessageHeader header;
 223
 224   /**
 225    * GNUNET_OK if the transmission succeeded,
 226    * GNUNET_SYSERR if it failed (i.e. network disconnect);
 227    * in either case, it is now OK for this client to
 228    * send us another message for the given peer.
 229    */
 230   uint32_t success GNUNET_PACKED;
 231
 232   /**
 233    * Latency estimate.
 234    */
 235   struct GNUNET_TIME_RelativeNBO latency;
 236
 237   /**
 238    * Which peer can send more now?
 239    */
 240   struct GNUNET_PeerIdentity peer;
 241
 242 };
 243
 244
 245 /**
 246  * Message used to notify the transport service about a message
 247  * to be transmitted to another peer.  The actual message follows.
 248  */
 249 struct OutboundMessage
 250 {
 251
 252   /**
 253    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
 254    */
 255   struct GNUNET_MessageHeader header;
 256
 257   /**
 258    * Message priority.
 259    */
 260   uint32_t priority GNUNET_PACKED;
 261
 262   /**
 263    * Allowed delay.
 264    */
 265   struct GNUNET_TIME_RelativeNBO timeout;
 266
 267   /**
 268    * Which peer should receive the message?
 269    */
 270   struct GNUNET_PeerIdentity peer;
 271
 272 };
 273
 274
 275 /**
 276  * Message from the library to the transport service
 277  * asking for converting a transport address to a
 278  * human-readable UTF-8 string.
 279  */
 280 struct AddressLookupMessage
 281 {
 282
 283   /**
 284    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
 285    */
 286   struct GNUNET_MessageHeader header;
 287
 288   /**
 289    * Should the conversion use numeric IP addresses (otherwise
 290    * a reverse DNS lookup is OK -- if applicable).
 291    */
 292   int32_t numeric_only GNUNET_PACKED;
 293
 294   /**
 295    * timeout to give up.
 296    */
 297   struct GNUNET_TIME_AbsoluteNBO timeout;
 298
 299   /**
 300    * Length of the (binary) address in bytes, in big-endian.
 301    */
 302   uint32_t addrlen GNUNET_PACKED;
 303
 304   /* followed by 'addrlen' bytes of the actual address, then
 305      followed by the 0-terminated name of the transport */
 306 };
 307
 308
 309
 310 /**
 311  * Change in blacklisting (either request or notification,
 312  * depending on which direction it is going).
 313  */
 314 struct BlacklistMessage
 315 {
 316
 317   /**
 318    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
 319    * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
 320    */
 321   struct GNUNET_MessageHeader header;
 322
 323   /**
 324    * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
 325    * for the response.
 326    */
 327   uint32_t is_allowed GNUNET_PACKED;
 328
 329   /**
 330    * Which peer is being blacklisted or queried?
 331    */
 332   struct GNUNET_PeerIdentity peer;
 333
 334 };
 335
 336
 337 /* end of transport.h */
 338 #endif