- fix doxygen

[oweals/gnunet.git] / src / ats / gnunet-service-ats_addresses.h

diff --git a/src/ats/gnunet-service-ats_addresses.h b/src/ats/gnunet-service-ats_addresses.h
index 1d218ba57260cc3e69188f76328ecb6b72b030b6..33ff5869dc18dcbfe88e4562afa3398408c6cbe0 100644 (file)
--- a/src/ats/gnunet-service-ats_addresses.h
+++ b/src/ats/gnunet-service-ats_addresses.h
@@ -19,7 +19,7 @@
 */
 
 /**
- * @file ats/gnunet-service-ats_addresses.c
+ * @file ats/gnunet-service-ats_addresses.h
  * @brief ats service address management
  * @author Matthias Wachs
  * @author Christian Grothoff
@@ -28,15 +28,72 @@
 #define GNUNET_SERVICE_ATS_ADDRESSES_H
 
 #include "gnunet_util_lib.h"
-#include "gnunet_ats_service.h" 
+#include "gnunet_ats_service.h"
+#include "gnunet_statistics_service.h"
 #include "ats.h"
 
+struct ATS_Address
+{
+  struct ATS_Address *next;
+
+  struct ATS_Address *prev;
+
+  struct GNUNET_PeerIdentity peer;
+
+  size_t addr_len;
+
+  uint32_t session_id;
+
+  uint32_t ats_count;
+
+  const void *addr;
+
+  char *plugin;
+
+  void *mlp_information;
+
+  struct GNUNET_ATS_Information *ats;
+
+  struct GNUNET_TIME_Relative atsp_latency;
+
+  struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_in;
+
+  struct GNUNET_BANDWIDTH_Value32NBO atsp_utilization_out;
+
+  uint32_t atsp_distance;
+
+  uint32_t atsp_cost_wan;
+
+  uint32_t atsp_cost_lan;
+
+  uint32_t atsp_cost_wlan;
+
+  uint32_t atsp_network_type;
+
+  struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_in;
+
+  struct GNUNET_BANDWIDTH_Value32NBO assigned_bw_out;
+
+  /**
+   * Is this the active address for this peer?
+   */
+  int active;
+
+  /**
+   * Is this the address for this peer in use?
+   */
+  int used;
+};
+
 /**
  * Initialize address subsystem.
+ *
  * @param cfg configuration to use
+ * @param stats the statistics handle to use
  */
 void
-GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
+GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                    const struct GNUNET_STATISTICS_Handle *stats);
 
 
 /**
@@ -45,21 +102,26 @@ GAS_addresses_init (const struct GNUNET_CONFIGURATION_Handle *cfg);
 void
 GAS_addresses_done (void);
 
+/**
+ * This address is now used or not used anymore
+ */
+void
+GAS_addresses_in_use (const struct GNUNET_PeerIdentity *peer,
+                      const char *plugin_name, const void *plugin_addr,
+                      size_t plugin_addr_len, uint32_t session_id, int in_use);
 
 void
 GAS_addresses_update (const struct GNUNET_PeerIdentity *peer,
-                     const char *plugin_name,
-                     const void *plugin_addr, size_t plugin_addr_len,
-                     uint32_t session_id,
-                     const struct GNUNET_ATS_Information *atsi,
-                     uint32_t atsi_count);
+                      const char *plugin_name, const void *plugin_addr,
+                      size_t plugin_addr_len, uint32_t session_id,
+                      const struct GNUNET_ATS_Information *atsi,
+                      uint32_t atsi_count);
 
 
 void
 GAS_addresses_destroy (const struct GNUNET_PeerIdentity *peer,
-                      const char *plugin_name,
-                      const void *plugin_addr, size_t plugin_addr_len,
-                      uint32_t session_id);
+                       const char *plugin_name, const void *plugin_addr,
+                       size_t plugin_addr_len, uint32_t session_id);
 
 
 void
@@ -78,10 +140,12 @@ GAS_addresses_request_address (const struct GNUNET_PeerIdentity *peer);
 // not with 'addresses' in the future...
 void
 GAS_addresses_change_preference (const struct GNUNET_PeerIdentity *peer,
-                                enum GNUNET_ATS_PreferenceKind kind,
-                                float score);
+                                 enum GNUNET_ATS_PreferenceKind kind,
+                                 float score);
 
 
 /* FIXME: add performance request API */
 
 #endif
+
+/* end of gnunet-service-ats_addresses.h */