guix-env: some update.

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

diff --git a/src/ats/gnunet-service-ats_scheduling.h b/src/ats/gnunet-service-ats_scheduling.h
index 5c8f77ed823c8f8dff785d2beeff1ecda408d64f..26cb2c73afa55f90a7791c8ad7e8995416d1e078 100644 (file)
--- a/src/ats/gnunet-service-ats_scheduling.h
+++ b/src/ats/gnunet-service-ats_scheduling.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 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
@@ -14,41 +14,84 @@
 
      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.
 */
 
 /**
  * @file ats/gnunet-service-ats_scheduling.h
  * @brief ats service, interaction with 'scheduling' API
  * @author Matthias Wachs
+ * @author Christian Grothoff
  */
 #ifndef GNUNET_SERVICE_ATS_SCHEDULING_H
 #define GNUNET_SERVICE_ATS_SCHEDULING_H
 
 #include "gnunet_util_lib.h"
 
+
+/**
+ * Register a new scheduling client.
+ *
+ * @param client handle of the new client
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
+ */
+int
+GAS_scheduling_add_client (struct GNUNET_SERVICE_Client *client);
+
+
+/**
+ * Unregister a client (which may have been a scheduling client,
+ * but this is not assured).
+ *
+ * @param client handle of the (now dead) client
+ */
 void
-GAS_add_scheduling_client (struct GNUNET_SERVER_Client *client);
+GAS_scheduling_remove_client (struct GNUNET_SERVICE_Client *client);
 
 
+/**
+ * Transmit the given address suggestion and bandwidth update to all scheduling
+ * clients.
+ *
+ * @param peer peer for which this is an address suggestion
+ * @param session_id session ID to use
+ * @param bandwidth_out assigned outbound bandwidth
+ * @param bandwidth_in assigned inbound bandwidth
+ */
 void
-GAS_remove_scheduling_client (struct GNUNET_SERVER_Client *client);
+GAS_scheduling_transmit_address_suggestion (const struct GNUNET_PeerIdentity *peer,
+                                            uint32_t session_id,
+                                            struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
+                                            struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
 
 
+/**
+ * Handle 'address add' messages from clients.
+ *
+ * @param client client that sent the request
+ * @param m the request message
+ */
 void
-GAS_handle_request_address (void *cls, struct GNUNET_SERVER_Client *client,
-                           const struct GNUNET_MessageHeader *message);
+GAS_handle_address_add (const struct AddressAddMessage *m);
 
 
+/**
+ * Handle 'address update' messages from clients.
+ *
+ * @param m the request message
+ */
 void
-GAS_handle_address_update (void *cls, struct GNUNET_SERVER_Client *client,
-                          const struct GNUNET_MessageHeader *message);
+GAS_handle_address_update (const struct AddressUpdateMessage *m);
 
 
+/**
+ * Handle 'address destroyed' messages from clients.
+ *
+ * @param m the request message
+ */
 void
-GAS_handle_address_destroyed (void *cls, struct GNUNET_SERVER_Client *client,
-                             const struct GNUNET_MessageHeader *message);
+GAS_handle_address_destroyed (const struct AddressDestroyedMessage *m);
 
 
 #endif