-doxygen

[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 2852ab4bb5ab9a4694898bf2904526667d4f7994..2dc91de732432619040de8f2bdf4735f6c13de78 100644 (file)
--- a/src/transport/gnunet-service-transport_plugins.h
+++ b/src/transport/gnunet-service-transport_plugins.h
@@ -30,6 +30,7 @@
 #include "gnunet_transport_service.h"
 #include "gnunet_transport_plugin.h"
 #include "gnunet_util_lib.h"
+#include "gnunet_hello_lib.h"
 
 
 /**
@@ -40,13 +41,18 @@
  *
  * @param recv_cb function to call when data is received
  * @param address_cb function to call when our public addresses changed
+ * @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 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_SessionEnd session_end_cb);
-
+                  GNUNET_TRANSPORT_AddressNotification address_cb,
+                  GNUNET_TRANSPORT_SessionStart session_start_cb,
+                  GNUNET_TRANSPORT_SessionEnd session_end_cb,
+                  GNUNET_TRANSPORT_AddressToType address_type_cb,
+                  GNUNET_TRANSPORT_UpdateAddressMetrics metric_update_cb);
 
 /**
  * Unload all plugins
@@ -64,20 +70,29 @@ GST_plugins_unload (void);
 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);
 
 
 #endif