- fix doxygen

[oweals/gnunet.git] / src / ats / gnunet-service-ats_performance.h

diff --git a/src/ats/gnunet-service-ats_performance.h b/src/ats/gnunet-service-ats_performance.h
index 45bc39c359661ec2f7eb662c64eb630b085f63f9..75d555a6cd1046510e6afc2aa1f9001c72d9dc19 100644 (file)
--- a/src/ats/gnunet-service-ats_performance.h
+++ b/src/ats/gnunet-service-ats_performance.h
@@ -22,29 +22,102 @@
  * @file ats/gnunet-service-ats_performance.h
  * @brief ats service, interaction with 'performance' API
  * @author Matthias Wachs
+ * @author Christian Grothoff
  */
 #ifndef GNUNET_SERVICE_ATS_PERFORMANCE_H
 #define GNUNET_SERVICE_ATS_PERFORMANCE_H
 
 #include "gnunet_util_lib.h"
+#include "gnunet_ats_service.h"
+#include "ats.h"
 
+/**
+ * Register a new performance client.
+ *
+ * @param client handle of the new client
+ * @param flag flag specifying the type of the client
+ */
+void
+GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
+                            enum StartFlag flag);
+
+
+/**
+ * Unregister a client (which may have been a performance client,
+ * but this is not assured).
+ *
+ * @param client handle of the (now dead) client
+ */
 void
-GAS_add_performance_client (struct GNUNET_SERVER_Client *client);
+GAS_performance_remove_client (struct GNUNET_SERVER_Client *client);
 
 
+/**
+ * Transmit the given performance information to all performance
+ * clients.
+ *
+ * @param peer peer for which this is an address suggestion
+ * @param plugin_name 0-termintated string specifying the transport plugin
+ * @param plugin_addr binary address for the plugin to use
+ * @param plugin_addr_len number of bytes in plugin_addr
+ * @param atsi performance data for the address
+ * @param atsi_count number of performance records in 'ats'
+ * @param bandwidth_out assigned outbound bandwidth
+ * @param bandwidth_in assigned inbound bandwidth
+ */
 void
-GAS_remove_performance_client (struct GNUNET_SERVER_Client *client);
+GAS_performance_notify_clients (const struct GNUNET_PeerIdentity *peer,
+                                const char *plugin_name,
+                                const void *plugin_addr, size_t plugin_addr_len,
+                                const struct GNUNET_ATS_Information *atsi,
+                                uint32_t atsi_count,
+                                struct GNUNET_BANDWIDTH_Value32NBO
+                                bandwidth_out,
+                                struct GNUNET_BANDWIDTH_Value32NBO
+                                bandwidth_in);
 
 
+/**
+ * Handle 'reservation request' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
-                               const struct GNUNET_MessageHeader *message);
+                                const struct GNUNET_MessageHeader *message);
 
 
+/**
+ * Handle 'preference change' messages from clients.
+ *
+ * @param cls unused, NULL
+ * @param client client that sent the request
+ * @param message the request message
+ */
 void
 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
-                             const struct GNUNET_MessageHeader *message);
+                              const struct GNUNET_MessageHeader *message);
+
+
+/**
+ * Initialize performance subsystem.
+ *
+ * @param server handle to our server
+ */
+void
+GAS_performance_init (struct GNUNET_SERVER_Handle *server);
+
+
+/**
+ * Shutdown performance subsystem.
+ */
+void
+GAS_performance_done (void);
+
 
+/* FIXME: add API to broadcast performance updates! */
 
 #endif
 /* end of gnunet-service-ats_performance.h */