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 void
  56 GAS_handle_performance_update (struct GNUNET_PeerIdentity *peer,
  57                                                                                                                          struct GNUNET_ATS_Information *ats,
  58                                                                                                                          uint32_t ats_count);
  59
  60 /**
  61  * Transmit the given performance information to all performance
  62  * clients.
  63  *
  64  * @param peer peer for which this is an address suggestion
  65  * @param plugin_name 0-termintated string specifying the transport plugin
  66  * @param plugin_addr binary address for the plugin to use
  67  * @param plugin_addr_len number of bytes in plugin_addr
  68  * @param active is this address active
  69  * @param atsi performance data for the address
  70  * @param atsi_count number of performance records in 'ats'
  71  * @param bandwidth_out assigned outbound bandwidth
  72  * @param bandwidth_in assigned inbound bandwidth
  73  */
  74 void
  75 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
  76                                 const char *plugin_name,
  77                                 const void *plugin_addr, size_t plugin_addr_len,
  78                                 const int active,
  79                                 const struct GNUNET_ATS_Information *atsi,
  80                                 uint32_t atsi_count,
  81                                 struct GNUNET_BANDWIDTH_Value32NBO
  82                                 bandwidth_out,
  83                                 struct GNUNET_BANDWIDTH_Value32NBO
  84                                 bandwidth_in);
  85
  86
  87 /**
  88  * Handle 'address list request' messages from clients.
  89  *
  90  * @param cls unused, NULL
  91  * @param client client that sent the request
  92  * @param message the request message
  93  */
  94 void
  95 GAS_handle_request_address_list (void *cls,
  96                                  struct GNUNET_SERVER_Client *client,
  97                                  const struct GNUNET_MessageHeader *message);
  98
  99 /**
 100  * Handle 'reservation request' messages from clients.
 101  *
 102  * @param cls unused, NULL
 103  * @param client client that sent the request
 104  * @param message the request message
 105  */
 106 void
 107 GAS_handle_reservation_request (void *cls,
 108                                 struct GNUNET_SERVER_Client *client,
 109                                 const struct GNUNET_MessageHeader *message);
 110
 111
 112 /**
 113  * Handle 'preference change' messages from clients.
 114  *
 115  * @param cls unused, NULL
 116  * @param client client that sent the request
 117  * @param message the request message
 118  */
 119 void
 120 GAS_handle_preference_change (void *cls,
 121                               struct GNUNET_SERVER_Client *client,
 122                               const struct GNUNET_MessageHeader *message);
 123
 124
 125 void
 126 GAS_handle_monitor (void *cls,
 127                                                                                                         struct GNUNET_SERVER_Client *client,
 128                           const struct GNUNET_MessageHeader *message);
 129
 130 /**
 131  * Initialize performance subsystem.
 132  *
 133  * @param server handle to our server
 134  * @param addresses the address handle to use
 135  */
 136 void
 137 GAS_performance_init (struct GNUNET_SERVER_Handle *server,
 138                       struct GAS_Addresses_Handle *GSA_addresses);
 139
 140
 141 /**
 142  * Shutdown performance subsystem.
 143  */
 144 void
 145 GAS_performance_done (void);
 146
 147
 148 /* FIXME: add API to broadcast performance updates! */
 149
 150 #endif
 151 /* end of gnunet-service-ats_performance.h */