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