src/ats/gnunet-service-ats_addresses.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_addresses.h
  23  * @brief ats service address management
  24  * @author Matthias Wachs
  25  * @author Christian Grothoff
  26  */
  27 #ifndef GNUNET_SERVICE_ATS_ADDRESSES_H
  28 #define GNUNET_SERVICE_ATS_ADDRESSES_H
  29
  30 #include "gnunet_util_lib.h"
  31 #include "gnunet_ats_service.h"
  32 #include "gnunet_statistics_service.h"
  33 #include "ats.h"
  34
  35 struct ATS_Address
  36 {
  37   struct GNUNET_PeerIdentity peer;
  38
  39   size_t addr_len;
  40
  41   uint32_t session_id;
  42
  43   uint32_t ats_count;
  44
  45   const void *addr;
  46
  47   char *plugin;
  48
  49   void *mlp_information;
  50
  51   struct GNUNET_ATS_Information *ats;
  52
  53   struct GNUNET_TIME_Relative atsp_latency;
  54
  55   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
  56
  57   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
  58
  59   uint32_t atsp_distance;
  60
  61   uint32_t atsp_cost_wan;
  62
  63   uint32_t atsp_cost_lan;
  64
  65   uint32_t atsp_cost_wlan;
  66
  67   uint32_t atsp_network_type;
  68
  69   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
  70
  71   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
  72
  73   /**
  74    * Is this the active address for this peer?
  75    */
  76   int active;
  77
  78   /**
  79    * Is this the address for this peer in use?
  80    */
  81   int used;
  82 };
  83
  84 /**
  85  * Initialize address subsystem.
  86  *
  87  * @param cfg configuration to use
  88  * @param stats the statistics handle to use
  89  */
  90 void
  91 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
  92                     const struct GNUNET_STATISTICS_Handle *stats);
  93
  94
  95 /**
  96  * Shutdown address subsystem.
  97  */
  98 void
  99 GAS_addresses_done (void);
 100
 101 /**
 102  * This address is now used or not used anymore
 103  */
 104 void
 105 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
 106                       const char *plugin_name, const void *plugin_addr,
 107                       size_t plugin_addr_len, uint32_t session_id, int in_use);
 108
 109 void
 110 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 111                       const char *plugin_name, const void *plugin_addr,
 112                       size_t plugin_addr_len, uint32_t session_id,
 113                       const struct GNUNET_ATS_Information *atsi,
 114                       uint32_t atsi_count);
 115
 116
 117 void
 118 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 119                        const char *plugin_name, const void *plugin_addr,
 120                        size_t plugin_addr_len, uint32_t session_id);
 121
 122
 123 void
 124 GAS_addresses_destroy_all (void);
 125
 126
 127 // FIXME: this function should likely end up in the LP-subsystem and
 128 // not with 'addresses' in the future...
 129 // Note: this call should trigger an address suggestion
 130 // (GAS_scheduling_transmit_address_suggestion)
 131 void
 132 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 133
 134
 135 // FIXME: this function should likely end up in the LP-subsystem and
 136 // not with 'addresses' in the future...
 137 void
 138 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
 139                                  enum GNUNET_ATS_PreferenceKind kind,
 140                                  float score);
 141
 142
 143 /* FIXME: add performance request API */
 144
 145 #endif
 146
 147 /* end of gnunet-service-ats_addresses.h */