src/transport/plugin_transport_template.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 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 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_template.c
  23  * @brief template for a new transport service
  24  * @author Christian Grothoff
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_connection_lib.h"
  30 #include "gnunet_server_lib.h"
  31 #include "gnunet_service_lib.h"
  32 #include "gnunet_statistics_service.h"
  33 #include "gnunet_transport_service.h"
  34 #include "plugin_transport.h"
  35
  36 #define DEBUG_TEMPLATE GNUNET_NO
  37
  38 /**
  39  * After how long do we expire an address that we
  40  * learned from another peer if it is not reconfirmed
  41  * by anyone?
  42  */
  43 #define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
  44
  45
  46 /**
  47  * Encapsulation of all of the state of the plugin.
  48  */
  49 struct Plugin;
  50
  51
  52 /**
  53  * Session handle for connections.
  54  */
  55 struct Session
  56 {
  57
  58   /**
  59    * Stored in a linked list.
  60    */
  61   struct Session *next;
  62
  63   /**
  64    * Pointer to the global plugin struct.
  65    */
  66   struct Plugin *plugin;
  67
  68   /**
  69    * The client (used to identify this connection)
  70    */
  71   /* void *client; */
  72
  73   /**
  74    * Continuation function to call once the transmission buffer
  75    * has again space available.  NULL if there is no
  76    * continuation to call.
  77    */
  78   GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
  79
  80   /**
  81    * Closure for transmit_cont.
  82    */
  83   void *transmit_cont_cls;
  84
  85   /**
  86    * To whom are we talking to (set to our identity
  87    * if we are still waiting for the welcome message)
  88    */
  89   struct GNUNET_PeerIdentity sender;
  90
  91   /**
  92    * At what time did we reset last_received last?
  93    */
  94   struct GNUNET_TIME_Absolute last_quota_update;
  95
  96   /**
  97    * How many bytes have we received since the "last_quota_update"
  98    * timestamp?
  99    */
 100   uint64_t last_received;
 101
 102   /**
 103    * Number of bytes per ms that this peer is allowed
 104    * to send to us.
 105    */
 106   uint32_t quota;
 107
 108 };
 109
 110 /**
 111  * Encapsulation of all of the state of the plugin.
 112  */
 113 struct Plugin
 114 {
 115   /**
 116    * Our environment.
 117    */
 118   struct GNUNET_TRANSPORT_PluginEnvironment *env;
 119
 120   /**
 121    * List of open sessions.
 122    */
 123   struct Session *sessions;
 124
 125   /**
 126    * Handle for the statistics service.
 127    */
 128   struct GNUNET_STATISTICS_Handle *statistics;
 129
 130 };
 131
 132 /**
 133  * Function that can be used by the transport service to transmit
 134  * a message using the plugin.
 135  *
 136  * @param cls closure
 137  * @param target who should receive this message
 138  * @param priority how important is the message
 139  * @param msgbuf the message to transmit
 140  * @param msgbuf_size number of bytes in 'msgbuf'
 141  * @param timeout when should we time out
 142  * @param session which session must be used (or NULL for "any")
 143  * @param addr the address to use (can be NULL if the plugin
 144  *                is "on its own" (i.e. re-use existing TCP connection))
 145  * @param addrlen length of the address in bytes
 146  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 147  *                otherwise the plugin may use other addresses or
 148  *                existing connections (if available)
 149  * @param cont continuation to call once the message has
 150  *        been transmitted (or if the transport is ready
 151  *        for the next transmission call; or if the
 152  *        peer disconnected...)
 153  * @param cont_cls closure for cont
 154  * @return number of bytes used (on the physical network, with overheads);
 155  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 156  *         and does NOT mean that the message was not transmitted (DV)
 157  */
 158 static ssize_t
 159 template_plugin_send (void *cls,
 160                       const struct GNUNET_PeerIdentity *
 161                       target,
 162                       const char *msgbuf,
 163                       size_t msgbuf_size,
 164                       unsigned int priority,
 165                       struct GNUNET_TIME_Relative timeout,
 166                       struct Session *session,
 167                       const void *addr,
 168                       size_t addrlen,
 169                       int force_address,
 170                       GNUNET_TRANSPORT_TransmitContinuation
 171                       cont, void *cont_cls)
 172 {
 173   int bytes_sent = 0;
 174   /*  struct Plugin *plugin = cls; */
 175   return bytes_sent;
 176 }
 177
 178
 179
 180 /**
 181  * Function that can be used to force the plugin to disconnect
 182  * from the given peer and cancel all previous transmissions
 183  * (and their continuationc).
 184  *
 185  * @param cls closure
 186  * @param target peer from which to disconnect
 187  */
 188 static void
 189 template_plugin_disconnect (void *cls,
 190                             const struct GNUNET_PeerIdentity *target)
 191 {
 192   // struct Plugin *plugin = cls;
 193   // FIXME
 194 }
 195
 196
 197 /**
 198  * Convert the transports address to a nice, human-readable
 199  * format.
 200  *
 201  * @param cls closure
 202  * @param type name of the transport that generated the address
 203  * @param addr one of the addresses of the host, NULL for the last address
 204  *        the specific address format depends on the transport
 205  * @param addrlen length of the address
 206  * @param numeric should (IP) addresses be displayed in numeric form?
 207  * @param timeout after how long should we give up?
 208  * @param asc function to call on each string
 209  * @param asc_cls closure for asc
 210  */
 211 static void
 212 template_plugin_address_pretty_printer (void *cls,
 213                                         const char *type,
 214                                         const void *addr,
 215                                         size_t addrlen,
 216                                         int numeric,
 217                                         struct GNUNET_TIME_Relative timeout,
 218                                         GNUNET_TRANSPORT_AddressStringCallback
 219                                         asc, void *asc_cls)
 220 {
 221   asc (asc_cls, NULL);
 222 }
 223
 224
 225
 226 /**
 227  * Another peer has suggested an address for this
 228  * peer and transport plugin.  Check that this could be a valid
 229  * address.  If so, consider adding it to the list
 230  * of addresses.
 231  *
 232  * @param cls closure
 233  * @param addr pointer to the address
 234  * @param addrlen length of addr
 235  * @return GNUNET_OK if this is a plausible address for this peer
 236  *         and transport
 237  */
 238 static int
 239 template_plugin_address_suggested (void *cls,
 240                                   void *addr, size_t addrlen)
 241 {
 242   /* struct Plugin *plugin = cls; */
 243
 244   /* check if the address is plausible; if so,
 245      add it to our list! */
 246   return GNUNET_OK;
 247 }
 248
 249
 250 /**
 251  * Function called for a quick conversion of the binary address to
 252  * a numeric address.  Note that the caller must not free the
 253  * address and that the next call to this function is allowed
 254  * to override the address again.
 255  *
 256  * @param cls closure
 257  * @param addr binary address
 258  * @param addr_len length of the address
 259  * @return string representing the same address
 260  */
 261 static const char*
 262 template_plugin_address_to_string (void *cls,
 263                                    const void *addr,
 264                                    size_t addrlen)
 265 {
 266   GNUNET_break (0);
 267   return NULL;
 268 }
 269
 270
 271
 272
 273 /**
 274  * Entry point for the plugin.
 275  */
 276 void *
 277 gnunet_plugin_transport_template_init (void *cls)
 278 {
 279   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 280   struct GNUNET_TRANSPORT_PluginFunctions *api;
 281   struct Plugin *plugin;
 282
 283   plugin = GNUNET_malloc (sizeof (struct Plugin));
 284   plugin->env = env;
 285   plugin->statistics = NULL;
 286   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
 287   api->cls = plugin;
 288   api->send = &template_plugin_send;
 289   api->disconnect = &template_plugin_disconnect;
 290   api->address_pretty_printer = &template_plugin_address_pretty_printer;
 291   api->check_address = &template_plugin_address_suggested;
 292   api->address_to_string = &template_plugin_address_to_string;
 293   return api;
 294 }
 295
 296
 297 /**
 298  * Exit point from the plugin.
 299  */
 300 void *
 301 gnunet_plugin_transport_template_done (void *cls)
 302 {
 303   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 304   struct Plugin *plugin = api->cls;
 305
 306   GNUNET_free (plugin);
 307   GNUNET_free (api);
 308   return NULL;
 309 }
 310
 311 /* end of plugin_transport_template.c */