2 This file is part of GNUnet.
3 (C) 2010,2011 Christian Grothoff (and other contributing authors)
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.
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.
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.
22 * @file transport/gnunet-service-transport_plugins.h
23 * @brief plugin management API
24 * @author Christian Grothoff
26 #ifndef GNUNET_SERVICE_TRANSPORT_PLUGINS_H
27 #define GNUNET_SERVICE_TRANSPORT_PLUGINS_H
29 #include "gnunet_statistics_service.h"
30 #include "gnunet_transport_service.h"
31 #include "gnunet_transport_plugin.h"
32 #include "gnunet_util_lib.h"
33 #include "gnunet_hello_lib.h"
37 * Load and initialize all plugins. The respective functions will be
38 * invoked by the plugins when the respective events happen. The
39 * closure will be set to a 'const char*' containing the name of the
40 * plugin that caused the call.
42 * @param recv_cb function to call when data is received
43 * @param register_quota_cb function to call to register a quota callback
44 * @param unregister_quota_cb function to call to unregister a quota callback
45 * @param address_cb function to call when our public addresses changed
46 * @param session_start_cb function to call when a session was created
47 * @param session_end_cb function to call when a session was terminated
48 * @param address_type_cb function to call when a address type is requested
49 * @param metric_update_cb function to call when address metrics change
52 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
53 GNUNET_TRANSPORT_AddressNotification address_cb,
54 GNUNET_TRANSPORT_SessionStart session_start_cb,
55 GNUNET_TRANSPORT_SessionEnd session_end_cb,
56 GNUNET_TRANSPORT_AddressToType address_type_cb,
57 GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb);
63 GST_plugins_unload (void);
67 * Obtain the plugin API based on a plugin name.
69 * @param name name of the plugin
70 * @return the plugin's API, NULL if the plugin is not loaded
72 struct GNUNET_TRANSPORT_PluginFunctions *
73 GST_plugins_find (const char *name);
77 * Obtain the plugin API based on a the stripped plugin name after the underscore.
79 * Example: GST_plugins_printer_find (http_client) will return all plugins
80 * starting with the prefix "http":
81 * http_client or server if loaded
83 * @param name name of the plugin
84 * @return the plugin's API, NULL if the plugin is not loaded
86 struct GNUNET_TRANSPORT_PluginFunctions *
87 GST_plugins_printer_find (const char *name);
91 * Convert a given address to a human-readable format. Note that the
92 * return value will be overwritten on the next call to this function.
94 * @param address address to convert
95 * @return statically allocated (!) human-readable address
98 GST_plugins_a2s (const struct GNUNET_HELLO_Address *address);
102 * Register callback with all plugins to monitor their status.
104 * @param cb callback to register, NULL to unsubscribe
105 * @param cb_cls closure for @a cb
108 GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
113 /* end of file gnunet-service-transport_plugins.h */