src/ats/gnunet-service-ats_performance.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2011 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file ats/gnunet-service-ats_performance.h
  23  * @brief ats service, interaction with 'performance' API
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_SERVICE_ATS_PERFORMANCE_H
  28 #define GNUNET_SERVICE_ATS_PERFORMANCE_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_ats_service.h"
  32 #include "ats.h"
  33
  34 /**
  35  * Register a new performance client.
  36  *
  37  * @param client handle of the new client
  38  * @param flag flag specifying the type of the client
  39  */
  40 void
  41 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
  42                             enum StartFlag flag);
  43
  44
  45 /**
  46  * Unregister a client (which may have been a performance client,
  47  * but this is not assured).
  48  *
  49  * @param client handle of the (now dead) client
  50  */
  51 void
  52 GAS_performance_remove_client (struct GNUNET_SERVER_Client *client);
  53
  54
  55 /**
  56  * Transmit the given performance information to all performance
  57  * clients.
  58  *
  59  * @param peer peer for which this is an address suggestion
  60  * @param plugin_name 0-termintated string specifying the transport plugin
  61  * @param plugin_addr binary address for the plugin to use
  62  * @param plugin_addr_len number of bytes in plugin_addr
  63  * @param atsi performance data for the address
  64  * @param atsi_count number of performance records in 'ats'
  65  * @param bandwidth_out assigned outbound bandwidth
  66  * @param bandwidth_in assigned inbound bandwidth
  67  */
  68 void
  69 GAS_performance_notify_clients (const struct GNUNET_PeerIdentity *peer,
  70                                 const char *plugin_name,
  71                                 const void *plugin_addr, size_t plugin_addr_len,
  72                                 const struct GNUNET_ATS_Information *atsi,
  73                                 uint32_t atsi_count,
  74                                 struct GNUNET_BANDWIDTH_Value32NBO
  75                                 bandwidth_out,
  76                                 struct GNUNET_BANDWIDTH_Value32NBO
  77                                 bandwidth_in);
  78
  79
  80 /**
  81  * Handle 'reservation request' messages from clients.
  82  *
  83  * @param cls unused, NULL
  84  * @param client client that sent the request
  85  * @param message the request message
  86  */
  87 void
  88 GAS_handle_reservation_request (void *cls, struct GNUNET_SERVER_Client *client,
  89                                 const struct GNUNET_MessageHeader *message);
  90
  91
  92 /**
  93  * Handle 'preference change' messages from clients.
  94  *
  95  * @param cls unused, NULL
  96  * @param client client that sent the request
  97  * @param message the request message
  98  */
  99 void
 100 GAS_handle_preference_change (void *cls, struct GNUNET_SERVER_Client *client,
 101                               const struct GNUNET_MessageHeader *message);
 102
 103
 104 /**
 105  * Initialize performance subsystem.
 106  *
 107  * @param server handle to our server
 108  */
 109 void
 110 GAS_performance_init (struct GNUNET_SERVER_Handle *server);
 111
 112
 113 /**
 114  * Shutdown performance subsystem.
 115  */
 116 void
 117 GAS_performance_done (void);
 118
 119
 120 /* FIXME: add API to broadcast performance updates! */
 121
 122 #endif
 123 /* end of gnunet-service-ats_performance.h */