-bringing copyright tags up to FSF standard

[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..f09b52375045014dae2375f32cfd6dfbbcac93f9 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
@@ -21,11 +21,6 @@
  * @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
@@ -72,9 +67,14 @@ GST_ats_block_address (const struct GNUNET_HELLO_Address *address,
                        struct Session *session);
 
 
+/* FIXME: might want to add a function to reset the
+   back-off from blocking */
+
 /**
- * Notify ATS about the new address including the network this address is
- * located in.
+ * 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
@@ -82,35 +82,36 @@ GST_ats_block_address (const struct GNUNET_HELLO_Address *address,
  * @param ats_count number of @a ats 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);
+GST_ats_add_inbound_address (const struct GNUNET_HELLO_Address *address,
+                             struct Session *session,
+                             const struct GNUNET_ATS_Information *ats,
+                             uint32_t ats_count);
 
 
 /**
- * Notify ATS about a new session now existing for the given
- * address.
+ * 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 session the session
+ * @param ats ats information
+ * @param ats_count number of @a ats information
  */
 void
-GST_ats_new_session (const struct GNUNET_HELLO_Address *address,
-                     struct Session *session);
+GST_ats_add_address (const struct GNUNET_HELLO_Address *address,
+                     const struct GNUNET_ATS_Information *ats,
+                     uint32_t ats_count);
 
 
 /**
- * Notify ATS about a new session now being in use (or not).
+ * Notify ATS about a new session now existing for the given
+ * address.
  *
  * @param address the address
  * @param session the session
- * @param in_use #GNUNET_YES or #GNUNET_NO
  */
 void
-GST_ats_set_in_use (const struct GNUNET_HELLO_Address *address,
-                    struct Session *session,
-                    int in_use);
+GST_ats_new_session (const struct GNUNET_HELLO_Address *address,
+                     struct Session *session);
 
 
 /**