src/transport/gnunet-service-transport_plugins.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2010,2011 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your 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      Affero General Public License for more details.
  14
  15      You should have received a copy of the GNU Affero General Public License
  16      along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 /**
  20  * @file transport/gnunet-service-transport_plugins.h
  21  * @brief plugin management API
  22  * @author Christian Grothoff
  23  */
  24 #ifndef GNUNET_SERVICE_TRANSPORT_PLUGINS_H
  25 #define GNUNET_SERVICE_TRANSPORT_PLUGINS_H
  26
  27 #include "gnunet_statistics_service.h"
  28 #include "gnunet_transport_service.h"
  29 #include "gnunet_transport_plugin.h"
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_hello_lib.h"
  32
  33
  34 /**
  35  * Load and initialize all plugins.  The respective functions will be
  36  * invoked by the plugins when the respective events happen.  The
  37  * closure will be set to a 'const char*' containing the name of the
  38  * plugin that caused the call.
  39  *
  40  * @param recv_cb function to call when data is received
  41  * @param register_quota_cb function to call to register a quota callback
  42  * @param unregister_quota_cb function to call to unregister a quota callback
  43  * @param address_cb function to call when our public addresses changed
  44  * @param session_start_cb function to call when a session was created
  45  * @param session_end_cb function to call when a session was terminated
  46  * @param address_type_cb function to call when a address type is requested
  47  * @param metric_update_cb function to call when address metrics change
  48  */
  49 void
  50 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
  51                   GNUNET_TRANSPORT_AddressNotification address_cb,
  52                   GNUNET_TRANSPORT_SessionStart session_start_cb,
  53                   GNUNET_TRANSPORT_SessionEnd session_end_cb);
  54
  55 /**
  56  * Unload all plugins
  57  */
  58 void
  59 GST_plugins_unload (void);
  60
  61
  62 /**
  63  * Obtain the plugin API based on a plugin name.
  64  *
  65  * @param name name of the plugin
  66  * @return the plugin's API, NULL if the plugin is not loaded
  67  */
  68 struct GNUNET_TRANSPORT_PluginFunctions *
  69 GST_plugins_find (const char *name);
  70
  71
  72 /**
  73  * Obtain the plugin API based on a the stripped plugin name after the underscore.
  74  *
  75  * Example: GST_plugins_printer_find (http_client) will return all plugins
  76  * starting with the prefix "http":
  77  * http_client or server if loaded
  78  *
  79  * @param name name of the plugin
  80  * @return the plugin's API, NULL if the plugin is not loaded
  81  */
  82 struct GNUNET_TRANSPORT_PluginFunctions *
  83 GST_plugins_printer_find (const char *name);
  84
  85
  86 /**
  87  * Convert a given address to a human-readable format.  Note that the
  88  * return value will be overwritten on the next call to this function.
  89  *
  90  * @param address address to convert
  91  * @return statically allocated (!) human-readable address
  92  */
  93 const char *
  94 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address);
  95
  96
  97 /**
  98  * Register callback with all plugins to monitor their status.
  99  *
 100  * @param cb callback to register, NULL to unsubscribe
 101  * @param cb_cls closure for @a cb
 102  */
 103 void
 104 GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
 105                                void *cb_cls);
 106
 107
 108 #endif
 109 /* end of file gnunet-service-transport_plugins.h */