-improve indentation, reduce duplication of PIDs in core's neighbour map

[oweals/gnunet.git] / src / transport / gnunet-service-transport_ats.h

diff --git a/src/transport/gnunet-service-transport_ats.h b/src/transport/gnunet-service-transport_ats.h
index 53c4caa6802e2c3ac5feb3dbe88f7fd49c00ad8e..323191a4d91a116992fed7ded72fa19a9fced9af 100644 (file)
--- a/src/transport/gnunet-service-transport_ats.h
+++ b/src/transport/gnunet-service-transport_ats.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2015 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2015 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,18 +14,13 @@
 
      You should have received a copy of the GNU General Public License
      along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 /**
  * @file transport/gnunet-service-transport_ats.h
  * @brief interfacing between transport and ATS service
  * @author Christian Grothoff
- *
- * FIXME:
- * - add API to give ATS feedback about an address that was
- *   suggested but did not work out (without fully 'deleting'
- *   it forever)
  */
 #ifndef GNUNET_SERVICE_TRANSPORT_ATS_H
 #define GNUNET_SERVICE_TRANSPORT_ATS_H
@@ -73,19 +68,44 @@ GST_ats_block_address (const struct GNUNET_HELLO_Address *address,
 
 
 /**
- * Notify ATS about the new address including the network this address is
- * located in.
+ * Reset address blocking time.  Resets the exponential
+ * back-off timer for this address to zero.  Done when
+ * an address was used to create a successful connection.
+ *
+ * @param address the address to reset the blocking timer
+ * @param session the session (can be NULL)
+ */
+void
+GST_ats_block_reset (const struct GNUNET_HELLO_Address *address,
+                     struct Session *session);
+
+
+/**
+ * Notify ATS about the a new inbound address.  We may already
+ * know the address (as this is called each time we receive
+ * a message from an inbound connection).  If the address is
+ * indeed new, make it available to ATS.
  *
  * @param address the address
  * @param session the session
- * @param ats ats information
- * @param ats_count number of @a ats information
+ * @param prop performance information
+ */
+void
+GST_ats_add_inbound_address (const struct GNUNET_HELLO_Address *address,
+                             struct Session *session,
+                             const struct GNUNET_ATS_Properties *prop);
+
+
+/**
+ * Notify ATS about the new address including the network this address is
+ * located in.  The address must NOT be inbound and must be new to ATS.
+ *
+ * @param address the address
+ * @param prop performance information
  */
 void
 GST_ats_add_address (const struct GNUNET_HELLO_Address *address,
-                     struct Session *session,
-                     const struct GNUNET_ATS_Information *ats,
-                     uint32_t ats_count);
+                     const struct GNUNET_ATS_Properties *prop);
 
 
 /**
@@ -101,31 +121,54 @@ GST_ats_new_session (const struct GNUNET_HELLO_Address *address,
 
 
 /**
- * Notify ATS about a new session now being in use (or not).
+ * Notify ATS about property changes to an address's properties.
+ * FIXME: we probably want to split this one up for the different
+ * updatable properties.
  *
  * @param address the address
  * @param session the session
- * @param in_use #GNUNET_YES or #GNUNET_NO
+ * @param prop updated performance information
  */
 void
-GST_ats_set_in_use (const struct GNUNET_HELLO_Address *address,
-                    struct Session *session,
-                    int in_use);
+GST_ats_update_metrics (const struct GNUNET_HELLO_Address *address,
+                       struct Session *session,
+                       const struct GNUNET_ATS_Properties *prop);
 
 
 /**
- * Notify ATS about property changes to an address
+ * Notify ATS about utilization changes to an address.
+ *
+ * @param address our information about the address
+ * @param bps_in new utilization inbound
+ * @param bps_out new utilization outbound
+ */
+void
+GST_ats_update_utilization (const struct GNUNET_HELLO_Address *address,
+                            uint32_t bps_in,
+                            uint32_t bps_out);
+
+
+/**
+ * Notify ATS about property changes to an address's properties.
  *
  * @param address the address
  * @param session the session
- * @param ats performance information
- * @param ats_count number of elements in @a ats
+ * @param delay new delay value
  */
 void
-GST_ats_update_metrics (const struct GNUNET_HELLO_Address *address,
-                       struct Session *session,
-                       const struct GNUNET_ATS_Information *ats,
-                       uint32_t ats_count);
+GST_ats_update_delay (const struct GNUNET_HELLO_Address *address,
+                      struct GNUNET_TIME_Relative delay);
+
+
+/**
+ * Notify ATS about property changes to an address's properties.
+ *
+ * @param address the address
+ * @param distance new distance value
+ */
+void
+GST_ats_update_distance (const struct GNUNET_HELLO_Address *address,
+                         uint32_t distance);
 
 
 /**