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