src/transport/plugin_transport.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2009, 2010 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 2, 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/plugin_transport.h
  23  * @brief API for the transport services.  This header
  24  *        specifies the struct that is given to the plugin's entry
  25  *        method and the other struct that must be returned.
  26  *        Note that the destructors of transport plugins will
  27  *        be given the value returned by the constructor
  28  *        and is expected to return a NULL pointer.
  29  *
  30  * TODO:
  31  * - consider moving DATA message (latency measurement)
  32  *   to service; avoids encapsulation overheads and
  33  *   would enable latency measurements for non-bidi
  34  *   transports.
  35  * -
  36  *
  37  * @author Christian Grothoff
  38  */
  39 #ifndef PLUGIN_TRANSPORT_H
  40 #define PLUGIN_TRANSPORT_H
  41
  42 #include "gnunet_configuration_lib.h"
  43 #include "gnunet_scheduler_lib.h"
  44 #include "gnunet_transport_service.h"
  45
  46
  47 /**
  48  * Function called by the transport for each received message.
  49  * This function should also be called with "NULL" for the
  50  * message to signal that the other peer disconnected.
  51  *
  52  * @param cls closure
  53  * @param distance in overlay hops; use 1 unless DV
  54  * @param sender_address binary address of the sender (if observed)
  55  * @param sender_address_len number of bytes in sender_address
  56  * @param peer (claimed) identity of the other peer
  57  * @param message the message, NULL if peer was disconnected
  58  */
  59 typedef void (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
  60                                                         unsigned int distance,
  61                                                         const char *sender_address,
  62                                                         size_t sender_address_len,
  63                                                         const struct
  64                                                         GNUNET_PeerIdentity *
  65                                                         peer,
  66                                                         const struct
  67                                                         GNUNET_MessageHeader *
  68                                                         message);
  69
  70
  71
  72 /**
  73  * Function that will be called for each address the transport
  74  * is aware that it might be reachable under.
  75  *
  76  * @param cls closure
  77  * @param name name of the transport that generated the address
  78  * @param addr one of the addresses of the host, NULL for the last address
  79  *        the specific address format depends on the transport
  80  * @param addrlen length of the address
  81  * @param expires when should this address automatically expire?
  82  */
  83 typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
  84                                                       const char *name,
  85                                                       const void *addr,
  86                                                       size_t addrlen,
  87                                                       struct
  88                                                       GNUNET_TIME_Relative
  89                                                       expires);
  90
  91
  92 /**
  93  * The transport service will pass a pointer to a struct
  94  * of this type as the first and only argument to the
  95  * entry point of each transport plugin.
  96  */
  97 struct GNUNET_TRANSPORT_PluginEnvironment
  98 {
  99   /**
 100    * Configuration to use.
 101    */
 102   const struct GNUNET_CONFIGURATION_Handle *cfg;
 103
 104   /**
 105    * Scheduler to use.
 106    */
 107   struct GNUNET_SCHEDULER_Handle *sched;
 108
 109   /**
 110    * Identity of this peer.
 111    */
 112   const struct GNUNET_PeerIdentity *my_identity;
 113
 114   /**
 115    * Closure for the various callbacks.
 116    */
 117   void *cls;
 118
 119   /**
 120    * Function that should be called by the transport plugin
 121    * whenever a message is received.
 122    */
 123   GNUNET_TRANSPORT_PluginReceiveCallback receive;
 124
 125   /**
 126    * Function that must be called by each plugin to notify the
 127    * transport service about the addresses under which the transport
 128    * provided by the plugin can be reached.
 129    */
 130   GNUNET_TRANSPORT_AddressNotification notify_address;
 131
 132   /**
 133    * What is the default quota (in terms of incoming bytes per
 134    * ms) for new connections?
 135    */
 136   uint32_t default_quota_in;
 137
 138   /**
 139    * What is the maximum number of connections that this transport
 140    * should allow?  Transports that do not have sessions (such as
 141    * UDP) can ignore this value.
 142    */
 143   uint32_t max_connections;
 144
 145 };
 146
 147
 148 /**
 149  * Function called by the GNUNET_TRANSPORT_TransmitFunction
 150  * upon "completion".
 151  *
 152  * @param cls closure
 153  * @param target who was the recipient of the message?
 154  * @param result GNUNET_OK on success
 155  *               GNUNET_SYSERR if the target disconnected;
 156  *               disconnect will ALSO be signalled using
 157  *               the ReceiveCallback.
 158  */
 159 typedef void
 160   (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
 161                                             const struct GNUNET_PeerIdentity *
 162                                             target, int result);
 163
 164
 165 /**
 166  * Function that can be used by the transport service to transmit
 167  * a message using the plugin.   Note that in the case of a
 168  * peer disconnecting, the continuation MUST be called
 169  * prior to the disconnect notification itself.  This function
 170  * will be called with this peer's HELLO message to initiate
 171  * a fresh connection to another peer.
 172  *
 173  * @param cls closure
 174  * @param target who should receive this message
 175  * @param msg the message to transmit
 176  * @param priority how important is the message (most plugins will
 177  *                 ignore message priority and just FIFO)
 178  * @param timeout how long to wait at most for the transmission (does not
 179  *                require plugins to discard the message after the timeout,
 180  *                just advisory for the desired delay; most plugins will ignore
 181  *                this as well)
 182  * @param addr the address to use (can be NULL if the plugin
 183  *                is "on its own" (i.e. re-use existing TCP connection))
 184  * @param addrlen length of the address in bytes
 185  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 186  *                otherwise the plugin may use other addresses or
 187  *                existing connections (if available)
 188  * @param cont continuation to call once the message has
 189  *        been transmitted (or if the transport is ready
 190  *        for the next transmission call; or if the
 191  *        peer disconnected...); can be NULL
 192  * @param cont_cls closure for cont
 193  * @return number of bytes used (on the physical network, with overheads);
 194  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 195  *         and does NOT mean that the message was not transmitted (DV)
 196  */
 197 typedef ssize_t
 198   (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
 199                                         const struct GNUNET_PeerIdentity *
 200                                         target,
 201                                         const struct GNUNET_MessageHeader *msg,
 202                                         unsigned int priority,
 203                                         struct GNUNET_TIME_Relative timeout,
 204                                         const void *addr,
 205                                         size_t addrlen,
 206                                         int force_address,
 207                                         GNUNET_TRANSPORT_TransmitContinuation
 208                                         cont, void *cont_cls);
 209
 210
 211 /**
 212  * Function that can be called to force a disconnect from the
 213  * specified neighbour.  This should also cancel all previously
 214  * scheduled transmissions.  Obviously the transmission may have been
 215  * partially completed already, which is OK.  The plugin is supposed
 216  * to close the connection (if applicable) and no longer call the
 217  * transmit continuation(s).
 218  *
 219  * Finally, plugin MUST NOT call the services's receive function to
 220  * notify the service that the connection to the specified target was
 221  * closed after a getting this call.
 222  *
 223  * @param cls closure
 224  * @param target peer for which the last transmission is
 225  *        to be cancelled
 226  */
 227 typedef void
 228   (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
 229                                           const struct GNUNET_PeerIdentity *
 230                                           target);
 231
 232
 233 /**
 234  * Function called by the pretty printer for the resolved address for
 235  * each human-readable address obtained.
 236  *
 237  * @param cls closure
 238  * @param hostname one of the names for the host, NULL
 239  *        on the last call to the callback
 240  */
 241 typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
 242                                                         const char *address);
 243
 244
 245 /**
 246  * Convert the transports address to a nice, human-readable
 247  * format.
 248  *
 249  * @param cls closure
 250  * @param name name of the transport that generated the address
 251  * @param addr one of the addresses of the host, NULL for the last address
 252  *        the specific address format depends on the transport
 253  * @param addrlen length of the address
 254  * @param numeric should (IP) addresses be displayed in numeric form?
 255  * @param timeout after how long should we give up?
 256  * @param asc function to call on each string
 257  * @param asc_cls closure for asc
 258  */
 259 typedef void
 260   (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
 261                                             const char *type,
 262                                             const void *addr,
 263                                             size_t addrlen,
 264                                             int numeric,
 265                                             struct GNUNET_TIME_Relative
 266                                             timeout,
 267                                             GNUNET_TRANSPORT_AddressStringCallback
 268                                             asc, void *asc_cls);
 269
 270
 271 /**
 272  * Set a quota for receiving data from the given peer; this is a
 273  * per-transport limit.  The transport should limit its read/select
 274  * calls to stay below the quota (in terms of incoming data).
 275  *
 276  * @param cls closure
 277  * @param peer the peer for whom the quota is given
 278  * @param quota_in quota for receiving/sending data in bytes per ms
 279  */
 280 typedef void
 281   (*GNUNET_TRANSPORT_SetQuota) (void *cls,
 282                                 const struct GNUNET_PeerIdentity * target,
 283                                 uint32_t quota_in);
 284
 285
 286 /**
 287  * Another peer has suggested an address for this peer and transport
 288  * plugin.  Check that this could be a valid address.  This function
 289  * is not expected to 'validate' the address in the sense of trying to
 290  * connect to it but simply to see if the binary format is technically
 291  * legal for establishing a connection.
 292  *
 293  * @param addr pointer to the address
 294  * @param addrlen length of addr
 295  * @return GNUNET_OK if this is a plausible address for this peer
 296  *         and transport, GNUNET_SYSERR if not
 297  */
 298 typedef int
 299   (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
 300                                     const void *addr, size_t addrlen);
 301
 302 /**
 303  * Each plugin is required to return a pointer to a struct of this
 304  * type as the return value from its entry point.
 305  */
 306 struct GNUNET_TRANSPORT_PluginFunctions
 307 {
 308
 309   /**
 310    * Closure for all of the callbacks.
 311    */
 312   void *cls;
 313
 314   /**
 315    * Function that the transport service will use to transmit data to
 316    * another peer.  May be null for plugins that only support
 317    * receiving data.  After this call, the plugin call the specified
 318    * continuation with success or error before notifying us about the
 319    * target having disconnected.
 320    */
 321   GNUNET_TRANSPORT_TransmitFunction send;
 322
 323   /**
 324    * Function that can be used to force the plugin to disconnect from
 325    * the given peer and cancel all previous transmissions (and their
 326    * continuations).  Note that if the transport does not have
 327    * sessions / persistent connections (for example, UDP), this
 328    * function may very well do nothing.
 329    */
 330   GNUNET_TRANSPORT_DisconnectFunction disconnect;
 331
 332   /**
 333    * Function to pretty-print addresses.  NOTE: this function is not
 334    * yet used by transport-service, but will be used in the future
 335    * once the transport-API has been completed.
 336    */
 337   GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
 338
 339   /**
 340    * Function that the transport service can use to try to enforce a
 341    * quota for the number of bytes received via this transport.
 342    * Transports that can not refuse incoming data (such as UDP)
 343    * are free to ignore these calls.
 344    */
 345   GNUNET_TRANSPORT_SetQuota set_receive_quota;
 346
 347   /**
 348    * Function that will be called to check if a binary address
 349    * for this plugin is well-formed.
 350    */
 351   GNUNET_TRANSPORT_CheckAddress check_address;
 352
 353
 354 };
 355
 356
 357 #endif