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