REST/NAMESTORE: rework API

[oweals/gnunet.git] / src / transport / gnunet-service-transport_plugins.h

diff --git a/src/transport/gnunet-service-transport_plugins.h b/src/transport/gnunet-service-transport_plugins.h
index f4a6857a216e787b47e3b8003ae67577c4e8d03e..cfb72dfedd261b0a5d58bf703ab75ad1098350b6 100644 (file)
--- a/src/transport/gnunet-service-transport_plugins.h
+++ b/src/transport/gnunet-service-transport_plugins.h
@@ -1,21 +1,21 @@
 /*
      This file is part of GNUnet.
-     (C) 2010,2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010,2011 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
@@ -30,6 +30,7 @@
 #include "gnunet_transport_service.h"
 #include "gnunet_transport_plugin.h"
 #include "gnunet_util_lib.h"
+#include "gnunet_hello_lib.h"
 
 
 /**
@@ -39,18 +40,19 @@
  * plugin that caused the call.
  *
  * @param recv_cb function to call when data is received
+ * @param register_quota_cb function to call to register a quota callback
+ * @param unregister_quota_cb function to call to unregister a quota callback
  * @param address_cb function to call when our public addresses changed
- * @param traffic_cb function to call for flow control
+ * @param session_start_cb function to call when a session was created
  * @param session_end_cb function to call when a session was terminated
- * @param cost_cb function to call about ATS cost changes
+ * @param address_type_cb function to call when a address type is requested
+ * @param metric_update_cb function to call when address metrics change
  */
-void 
+void
 GST_plugins_load (GNUNET_TRANSPORT_PluginReceiveCallback recv_cb,
-                 GNUNET_TRANSPORT_AddressNotification address_cb,
-                 GNUNET_TRANSPORT_TrafficReport traffic_cb,
-                 GNUNET_TRANSPORT_SessionEnd session_end_cb,
-                 GNUNET_TRANSPORT_CostReport cost_cb);
-
+                  GNUNET_TRANSPORT_AddressNotification address_cb,
+                  GNUNET_TRANSPORT_SessionStart session_start_cb,
+                  GNUNET_TRANSPORT_SessionEnd session_end_cb);
 
 /**
  * Unload all plugins
@@ -69,19 +71,40 @@ struct GNUNET_TRANSPORT_PluginFunctions *
 GST_plugins_find (const char *name);
 
 
+/**
+ * Obtain the plugin API based on a the stripped plugin name after the underscore.
+ *
+ * Example: GST_plugins_printer_find (http_client) will return all plugins
+ * starting with the prefix "http":
+ * http_client or server if loaded
+ *
+ * @param name name of the plugin
+ * @return the plugin's API, NULL if the plugin is not loaded
+ */
+struct GNUNET_TRANSPORT_PluginFunctions *
+GST_plugins_printer_find (const char *name);
+
+
 /**
  * Convert a given address to a human-readable format.  Note that the
  * return value will be overwritten on the next call to this function.
- * 
- * @param name plugin name
- * @param addr binary address in plugin-specific format
- * @param addrlen number of bytes in 'addr'
+ *
+ * @param address address to convert
  * @return statically allocated (!) human-readable address
  */
 const char *
-GST_plugins_a2s (const char *name,
-                const void *addr,
-                size_t addrlen);
+GST_plugins_a2s (const struct GNUNET_HELLO_Address *address);
+
+
+/**
+ * Register callback with all plugins to monitor their status.
+ *
+ * @param cb callback to register, NULL to unsubscribe
+ * @param cb_cls closure for @a cb
+ */
+void
+GST_plugins_monitor_subscribe (GNUNET_TRANSPORT_SessionInfoCallback cb,
+                              void *cb_cls);
 
 
 #endif