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 addr the address to use (can be NULL if the plugin
 143  *                is "on its own" (i.e. re-use existing TCP connection))
 144  * @param addrlen length of the address in bytes
 145  * @param force_address GNUNET_YES if the plugin MUST use the given address,
 146  *                otherwise the plugin may use other addresses or
 147  *                existing connections (if available)
 148  * @param cont continuation to call once the message has
 149  *        been transmitted (or if the transport is ready
 150  *        for the next transmission call; or if the
 151  *        peer disconnected...)
 152  * @param cont_cls closure for cont
 153  * @return number of bytes used (on the physical network, with overheads);
 154  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 155  *         and does NOT mean that the message was not transmitted (DV)
 156  */
 157 static ssize_t
 158 template_plugin_send (void *cls,
 159                       const struct GNUNET_PeerIdentity *
 160                       target,
 161                       const char *msgbuf,
 162                       size_t msgbuf_size,
 163                       unsigned int priority,
 164                       struct GNUNET_TIME_Relative timeout,
 165                       const void *addr,
 166                       size_t addrlen,
 167                       int force_address,
 168                       GNUNET_TRANSPORT_TransmitContinuation
 169                       cont, void *cont_cls)
 170 {
 171   int bytes_sent = 0;
 172   /*  struct Plugin *plugin = cls; */
 173   return bytes_sent;
 174 }
 175
 176
 177
 178 /**
 179  * Function that can be used to force the plugin to disconnect
 180  * from the given peer and cancel all previous transmissions
 181  * (and their continuationc).
 182  *
 183  * @param cls closure
 184  * @param target peer from which to disconnect
 185  */
 186 static void
 187 template_plugin_disconnect (void *cls,
 188                             const struct GNUNET_PeerIdentity *target)
 189 {
 190   // struct Plugin *plugin = cls;
 191   // FIXME
 192 }
 193
 194
 195 /**
 196  * Convert the transports address to a nice, human-readable
 197  * format.
 198  *
 199  * @param cls closure
 200  * @param type name of the transport that generated the address
 201  * @param addr one of the addresses of the host, NULL for the last address
 202  *        the specific address format depends on the transport
 203  * @param addrlen length of the address
 204  * @param numeric should (IP) addresses be displayed in numeric form?
 205  * @param timeout after how long should we give up?
 206  * @param asc function to call on each string
 207  * @param asc_cls closure for asc
 208  */
 209 static void
 210 template_plugin_address_pretty_printer (void *cls,
 211                                         const char *type,
 212                                         const void *addr,
 213                                         size_t addrlen,
 214                                         int numeric,
 215                                         struct GNUNET_TIME_Relative timeout,
 216                                         GNUNET_TRANSPORT_AddressStringCallback
 217                                         asc, void *asc_cls)
 218 {
 219   asc (asc_cls, NULL);
 220 }
 221
 222
 223
 224 /**
 225  * Another peer has suggested an address for this
 226  * peer and transport plugin.  Check that this could be a valid
 227  * address.  If so, consider adding it to the list
 228  * of addresses.
 229  *
 230  * @param cls closure
 231  * @param addr pointer to the address
 232  * @param addrlen length of addr
 233  * @return GNUNET_OK if this is a plausible address for this peer
 234  *         and transport
 235  */
 236 static int
 237 template_plugin_address_suggested (void *cls,
 238                                   void *addr, size_t addrlen)
 239 {
 240   /* struct Plugin *plugin = cls; */
 241
 242   /* check if the address is plausible; if so,
 243      add it to our list! */
 244   return GNUNET_OK;
 245 }
 246
 247
 248 /**
 249  * Entry point for the plugin.
 250  */
 251 void *
 252 gnunet_plugin_transport_template_init (void *cls)
 253 {
 254   struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
 255   struct GNUNET_TRANSPORT_PluginFunctions *api;
 256   struct Plugin *plugin;
 257
 258   plugin = GNUNET_malloc (sizeof (struct Plugin));
 259   plugin->env = env;
 260   plugin->statistics = NULL;
 261   api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
 262   api->cls = plugin;
 263   api->send = &template_plugin_send;
 264   api->disconnect = &template_plugin_disconnect;
 265   api->address_pretty_printer = &template_plugin_address_pretty_printer;
 266   api->check_address = &template_plugin_address_suggested;
 267   return api;
 268 }
 269
 270
 271 /**
 272  * Exit point from the plugin.
 273  */
 274 void *
 275 gnunet_plugin_transport_template_done (void *cls)
 276 {
 277   struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
 278   struct Plugin *plugin = api->cls;
 279
 280   GNUNET_free (plugin);
 281   GNUNET_free (api);
 282   return NULL;
 283 }
 284
 285 /* end of plugin_transport_template.c */