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 ATS_Address *next;
  38
  39   struct ATS_Address *prev;
  40
  41   struct GNUNET_PeerIdentity peer;
  42
  43   size_t addr_len;
  44
  45   uint32_t session_id;
  46
  47   uint32_t ats_count;
  48
  49   const void *addr;
  50
  51   char *plugin;
  52
  53   void *mlp_information;
  54
  55   struct GNUNET_ATS_Information *ats;
  56
  57   struct GNUNET_TIME_Relative atsp_latency;
  58
  59   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
  60
  61   struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
  62
  63   uint32_t atsp_distance;
  64
  65   uint32_t atsp_cost_wan;
  66
  67   uint32_t atsp_cost_lan;
  68
  69   uint32_t atsp_cost_wlan;
  70
  71   uint32_t atsp_network_type;
  72
  73   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
  74
  75   struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
  76
  77   /**
  78    * Blocking interval
  79    */
  80   struct GNUNET_TIME_Relative block_interval;
  81
  82   /**
  83    * Time when address can be suggested again
  84    */
  85   struct GNUNET_TIME_Absolute blocked_until;
  86
  87   /**
  88    * Is this the active address for this peer?
  89    */
  90   int active;
  91
  92   /**
  93    * Is this the address for this peer in use?
  94    */
  95   int used;
  96 };
  97
  98 /**
  99  * Initialize address subsystem.
 100  *
 101  * @param cfg configuration to use
 102  * @param stats the statistics handle to use
 103  */
 104 void
 105 GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
 106                     const struct GNUNET_STATISTICS_Handle *stats);
 107
 108
 109 /**
 110  * Shutdown address subsystem.
 111  */
 112 void
 113 GAS_addresses_done (void);
 114
 115 void
 116 GAS_addresses_handle_backoff_reset (const struct GNUNET_PeerIdentity *peer);
 117
 118 /**
 119  * This address is now used or not used anymore
 120  */
 121 int
 122 GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
 123                       const char *plugin_name, const void *plugin_addr,
 124                       size_t plugin_addr_len, uint32_t session_id, int in_use);
 125
 126 void
 127 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
 128                       const char *plugin_name, const void *plugin_addr,
 129                       size_t plugin_addr_len, uint32_t session_id,
 130                       const struct GNUNET_ATS_Information *atsi,
 131                       uint32_t atsi_count);
 132
 133
 134 void
 135 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
 136                        const char *plugin_name, const void *plugin_addr,
 137                        size_t plugin_addr_len, uint32_t session_id);
 138
 139
 140 void
 141 GAS_addresses_destroy_all (void);
 142
 143
 144 // FIXME: this function should likely end up in the LP-subsystem and
 145 // not with 'addresses' in the future...
 146 // Note: this call should trigger an address suggestion
 147 // (GAS_scheduling_transmit_address_suggestion)
 148 void
 149 GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 150
 151
 152 // FIXME: this function should likely end up in the LP-subsystem and
 153 // not with 'addresses' in the future...
 154 void
 155 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
 156                                  enum GNUNET_ATS_PreferenceKind kind,
 157                                  float score);
 158
 159
 160 /* FIXME: add performance request API */
 161
 162 #endif
 163
 164 /* end of gnunet-service-ats_addresses.h */