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