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