-add tests
[oweals/gnunet.git] / src / ats / gnunet-service-ats_performance.h
index 0ef481d48c5135af7629f924510f35f0d0520d97..7958a84e519eaa5731efed8cdea55ca6160607e4 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2011-2015 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
@@ -14,8 +14,8 @@
 
      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.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
 #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_performance_remove_client (struct GNUNET_SERVER_Client *client);
-
 
 /**
  * Transmit the given performance information to all performance
@@ -59,69 +39,47 @@ GAS_performance_remove_client (struct GNUNET_SERVER_Client *client);
  * @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 active is this address active
- * @param atsi performance data for the address
- * @param atsi_count number of performance records in 'ats'
+ * @param plugin_addr_len number of bytes in @a plugin_addr
+ * @param active #GNUNET_YES if this address is actively used
+ *        to maintain a connection to a peer;
+ *        #GNUNET_NO if the address is not actively used;
+ *        #GNUNET_SYSERR if this address is no longer available for ATS
+ * @param prop performance data for the address
+ * @param local_address_info information about the local flags for the address
  * @param bandwidth_out assigned outbound bandwidth
  * @param bandwidth_in assigned inbound bandwidth
  */
 void
 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
-                                const char *plugin_name,
-                                const void *plugin_addr, size_t plugin_addr_len,
-                                const int active,
-                                const struct GNUNET_ATS_Information *atsi,
-                                uint32_t atsi_count,
-                                struct GNUNET_BANDWIDTH_Value32NBO
-                                bandwidth_out,
-                                struct GNUNET_BANDWIDTH_Value32NBO
-                                bandwidth_in);
+                                    const char *plugin_name,
+                                    const void *plugin_addr,
+                                    size_t plugin_addr_len,
+                                    int active,
+                                    const struct GNUNET_ATS_Properties *prop,
+                                    enum GNUNET_HELLO_AddressInfo local_address_info,
+                                    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+                                    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 
 
 /**
- * Handle 'address list request' messages from clients.
- *
- * @param cls unused, NULL
- * @param client client that sent the request
- * @param message the request message
- */
-void
-GAS_handle_request_address_list (void *cls, struct GNUNET_SERVER_Client *client,
-                                 const struct GNUNET_MessageHeader *message);
-
-/**
- * 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);
-
-
-/**
- * Handle 'preference change' messages from clients.
+ * Register a new performance client.
  *
- * @param cls unused, NULL
- * @param client client that sent the request
- * @param message the request message
+ * @param client handle of the new client
+ * @param flag flag specifying the type of the client
  */
 void
-GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
-                              const struct GNUNET_MessageHeader *message);
+GAS_performance_add_client (struct GNUNET_SERVICE_Client *client,
+                            enum StartFlag flag);
 
 
 /**
  * Initialize performance subsystem.
  *
  * @param server handle to our server
+ * @param addresses the address handle to use
  */
 void
-GAS_performance_init (struct GNUNET_SERVER_Handle *server,
-                      struct GAS_Addresses_Handle *GSA_addresses);
+GAS_performance_init (void);
 
 
 /**
@@ -131,7 +89,5 @@ void
 GAS_performance_done (void);
 
 
-/* FIXME: add API to broadcast performance updates! */
-
 #endif
 /* end of gnunet-service-ats_performance.h */