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    * Transport distance metric (i.e. hops for DV)
  90    */
  91   uint32_t distance;
  92
  93   /**
  94    * Latency estimate.
  95    */
  96   struct GNUNET_TIME_RelativeNBO latency;
  97
  98   /**
  99    * Identity of the new neighbour.
 100    */
 101   struct GNUNET_PeerIdentity id;
 102
 103 };
 104
 105
 106 /**
 107  * Message from the transport service to the library
 108  * informing about disconnects.
 109  */
 110 struct DisconnectInfoMessage
 111 {
 112
 113   /**
 114    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
 115    */
 116   struct GNUNET_MessageHeader header;
 117
 118   /**
 119    * Reserved, always zero.
 120    */
 121   uint32_t reserved GNUNET_PACKED;
 122
 123   /**
 124    * Who got disconnected?
 125    */
 126   struct GNUNET_PeerIdentity peer;
 127
 128 };
 129
 130
 131 /**
 132  * Message used to set a particular bandwidth quota.  Send TO the
 133  * service to set an incoming quota, send FROM the service to update
 134  * an outgoing quota.
 135  */
 136 struct QuotaSetMessage
 137 {
 138
 139   /**
 140    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
 141    */
 142   struct GNUNET_MessageHeader header;
 143
 144   /**
 145    * Quota.
 146    */
 147   struct GNUNET_BANDWIDTH_Value32NBO quota;
 148
 149   /**
 150    * About which peer are we talking here?
 151    */
 152   struct GNUNET_PeerIdentity peer;
 153
 154 };
 155
 156
 157 /**
 158  * Message used to notify the transport API about a message
 159  * received from the network.  The actual message follows.
 160  */
 161 struct InboundMessage
 162 {
 163
 164   /**
 165    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
 166    */
 167   struct GNUNET_MessageHeader header;
 168
 169   /**
 170    * Always zero.
 171    */
 172   uint32_t reserved GNUNET_PACKED;
 173
 174   /**
 175    * Latency estimate.
 176    */
 177   struct GNUNET_TIME_RelativeNBO latency;
 178
 179   /**
 180    * Which peer sent the message?
 181    */
 182   struct GNUNET_PeerIdentity peer;
 183
 184   /**
 185    * Distance metric.
 186    */
 187   uint32_t distance;
 188
 189 };
 190
 191
 192 /**
 193  * Message used to notify the transport API that it can
 194  * send another message to the transport service.
 195  */
 196 struct SendOkMessage
 197 {
 198
 199   /**
 200    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
 201    */
 202   struct GNUNET_MessageHeader header;
 203
 204   /**
 205    * GNUNET_OK if the transmission succeeded,
 206    * GNUNET_SYSERR if it failed (i.e. network disconnect);
 207    * in either case, it is now OK for this client to
 208    * send us another message for the given peer.
 209    */
 210   uint32_t success GNUNET_PACKED;
 211
 212   /**
 213    * Latency estimate.
 214    */
 215   struct GNUNET_TIME_RelativeNBO latency;
 216
 217   /**
 218    * Which peer can send more now?
 219    */
 220   struct GNUNET_PeerIdentity peer;
 221
 222 };
 223
 224
 225 /**
 226  * Message used to notify the transport service about a message
 227  * to be transmitted to another peer.  The actual message follows.
 228  */
 229 struct OutboundMessage
 230 {
 231
 232   /**
 233    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
 234    */
 235   struct GNUNET_MessageHeader header;
 236
 237   /**
 238    * Message priority.
 239    */
 240   uint32_t priority GNUNET_PACKED;
 241
 242   /**
 243    * Allowed delay.
 244    */
 245   struct GNUNET_TIME_RelativeNBO timeout;
 246
 247   /**
 248    * Which peer should receive the message?
 249    */
 250   struct GNUNET_PeerIdentity peer;
 251
 252 };
 253
 254
 255 /**
 256  * Message from the library to the transport service
 257  * asking for converting a transport address to a
 258  * human-readable UTF-8 string.
 259  */
 260 struct AddressLookupMessage
 261 {
 262
 263   /**
 264    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
 265    */
 266   struct GNUNET_MessageHeader header;
 267
 268   /**
 269    * Should the conversion use numeric IP addresses (otherwise
 270    * a reverse DNS lookup is OK -- if applicable).
 271    */
 272   int32_t numeric_only GNUNET_PACKED;
 273
 274   /**
 275    * timeout to give up.
 276    */
 277   struct GNUNET_TIME_AbsoluteNBO timeout;
 278
 279   /**
 280    * Length of the (binary) address in bytes, in big-endian.
 281    */
 282   uint32_t addrlen GNUNET_PACKED;
 283
 284   /* followed by 'addrlen' bytes of the actual address, then
 285      followed by the 0-terminated name of the transport */
 286 };
 287
 288
 289
 290 /**
 291  * Change in blacklisting (either request or notification,
 292  * depending on which direction it is going).
 293  */
 294 struct BlacklistMessage
 295 {
 296
 297   /**
 298    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
 299    * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
 300    */
 301   struct GNUNET_MessageHeader header;
 302
 303   /**
 304    * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
 305    * for the response.
 306    */
 307   uint32_t is_allowed GNUNET_PACKED;
 308
 309   /**
 310    * Which peer is being blacklisted or queried?
 311    */
 312   struct GNUNET_PeerIdentity peer;
 313
 314 };
 315
 316
 317 /* end of transport.h */
 318 #endif