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  * 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.
 135  */
 136 struct TransportRequestConnectMessage
 137 {
 138   /**
 139    *  Message header
 140    */
 141   struct GNUNET_MessageHeader header;
 142
 143   /**
 144    * Identity of the peer we would like to connect to.
 145    */
 146   struct GNUNET_PeerIdentity peer;
 147 };
 148
 149 /**
 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
 152  * an outgoing quota.
 153  */
 154 struct QuotaSetMessage
 155 {
 156
 157   /**
 158    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_NEIGHBOUR_INFO
 159    */
 160   struct GNUNET_MessageHeader header;
 161
 162   /**
 163    * Quota.
 164    */
 165   struct GNUNET_BANDWIDTH_Value32NBO quota;
 166
 167   /**
 168    * About which peer are we talking here?
 169    */
 170   struct GNUNET_PeerIdentity peer;
 171
 172 };
 173
 174
 175 /**
 176  * Message used to notify the transport API about a message
 177  * received from the network.  The actual message follows.
 178  */
 179 struct InboundMessage
 180 {
 181
 182   /**
 183    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
 184    */
 185   struct GNUNET_MessageHeader header;
 186
 187   /**
 188    * Always zero.
 189    */
 190   uint32_t reserved GNUNET_PACKED;
 191
 192   /**
 193    * Latency estimate.
 194    */
 195   struct GNUNET_TIME_RelativeNBO latency;
 196
 197   /**
 198    * Which peer sent the message?
 199    */
 200   struct GNUNET_PeerIdentity peer;
 201
 202   /**
 203    * Distance metric.
 204    */
 205   uint32_t distance;
 206
 207 };
 208
 209
 210 /**
 211  * Message used to notify the transport API that it can
 212  * send another message to the transport service.
 213  */
 214 struct SendOkMessage
 215 {
 216
 217   /**
 218    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
 219    */
 220   struct GNUNET_MessageHeader header;
 221
 222   /**
 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.
 227    */
 228   uint32_t success GNUNET_PACKED;
 229
 230   /**
 231    * Latency estimate.
 232    */
 233   struct GNUNET_TIME_RelativeNBO latency;
 234
 235   /**
 236    * Which peer can send more now?
 237    */
 238   struct GNUNET_PeerIdentity peer;
 239
 240 };
 241
 242
 243 /**
 244  * Message used to notify the transport service about a message
 245  * to be transmitted to another peer.  The actual message follows.
 246  */
 247 struct OutboundMessage
 248 {
 249
 250   /**
 251    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
 252    */
 253   struct GNUNET_MessageHeader header;
 254
 255   /**
 256    * Message priority.
 257    */
 258   uint32_t priority GNUNET_PACKED;
 259
 260   /**
 261    * Allowed delay.
 262    */
 263   struct GNUNET_TIME_RelativeNBO timeout;
 264
 265   /**
 266    * Which peer should receive the message?
 267    */
 268   struct GNUNET_PeerIdentity peer;
 269
 270 };
 271
 272
 273 /**
 274  * Message from the library to the transport service
 275  * asking for converting a transport address to a
 276  * human-readable UTF-8 string.
 277  */
 278 struct AddressLookupMessage
 279 {
 280
 281   /**
 282    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_LOOKUP
 283    */
 284   struct GNUNET_MessageHeader header;
 285
 286   /**
 287    * Should the conversion use numeric IP addresses (otherwise
 288    * a reverse DNS lookup is OK -- if applicable).
 289    */
 290   int32_t numeric_only GNUNET_PACKED;
 291
 292   /**
 293    * timeout to give up.
 294    */
 295   struct GNUNET_TIME_AbsoluteNBO timeout;
 296
 297   /**
 298    * Length of the (binary) address in bytes, in big-endian.
 299    */
 300   uint32_t addrlen GNUNET_PACKED;
 301
 302   /* followed by 'addrlen' bytes of the actual address, then
 303      followed by the 0-terminated name of the transport */
 304 };
 305
 306
 307
 308 /**
 309  * Change in blacklisting (either request or notification,
 310  * depending on which direction it is going).
 311  */
 312 struct BlacklistMessage
 313 {
 314
 315   /**
 316    * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
 317    * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
 318    */
 319   struct GNUNET_MessageHeader header;
 320
 321   /**
 322    * 0 for the query, GNUNET_OK (allowed) or GNUNET_SYSERR (disallowed)
 323    * for the response.
 324    */
 325   uint32_t is_allowed GNUNET_PACKED;
 326
 327   /**
 328    * Which peer is being blacklisted or queried?
 329    */
 330   struct GNUNET_PeerIdentity peer;
 331
 332 };
 333
 334
 335 /* end of transport.h */
 336 #endif