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