src/ats/gnunet-service-ats_performance.h

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2011-2015 GNUnet e.V.
   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., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, 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 /**
  36  * Transmit the given performance information to all performance
  37  * clients.
  38  *
  39  * @param peer peer for which this is an address suggestion
  40  * @param plugin_name 0-termintated string specifying the transport plugin
  41  * @param plugin_addr binary address for the plugin to use
  42  * @param plugin_addr_len number of bytes in @a plugin_addr
  43  * @param active #GNUNET_YES if this address is actively used
  44  *        to maintain a connection to a peer;
  45  *        #GNUNET_NO if the address is not actively used;
  46  *        #GNUNET_SYSERR if this address is no longer available for ATS
  47  * @param prop performance data for the address
  48  * @param local_address_info information about the local flags for the address
  49  * @param bandwidth_out assigned outbound bandwidth
  50  * @param bandwidth_in assigned inbound bandwidth
  51  */
  52 void
  53 GAS_performance_notify_all_clients (const struct GNUNET_PeerIdentity *peer,
  54                                     const char *plugin_name,
  55                                     const void *plugin_addr,
  56                                     size_t plugin_addr_len,
  57                                     int active,
  58                                     const struct GNUNET_ATS_Properties *prop,
  59                                     enum GNUNET_HELLO_AddressInfo local_address_info,
  60                                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
  61                                     struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in);
  62
  63
  64 /**
  65  * Register a new performance client.
  66  *
  67  * @param client handle of the new client
  68  * @param flag flag specifying the type of the client
  69  */
  70 void
  71 GAS_performance_add_client (struct GNUNET_SERVER_Client *client,
  72                             enum StartFlag flag);
  73
  74
  75 /**
  76  * Initialize performance subsystem.
  77  *
  78  * @param server handle to our server
  79  * @param addresses the address handle to use
  80  */
  81 void
  82 GAS_performance_init (struct GNUNET_SERVER_Handle *server);
  83
  84
  85 /**
  86  * Shutdown performance subsystem.
  87  */
  88 void
  89 GAS_performance_done (void);
  90
  91
  92 #endif
  93 /* end of gnunet-service-ats_performance.h */