-more logging, avoid duplicate re-scheduling
[oweals/gnunet.git] / src / transport / gnunet-service-transport_validation.h
index d117faca5c80e713507100d4c53fbaf1f23d4746..458fda45380220de1d5333bedf8eb219f8743350 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2010,2011 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010,2011 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,8 +14,8 @@
 
      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.
 */
 
 /**
 #include "gnunet_util_lib.h"
 #include "gnunet_hello_lib.h"
 
-/**
- * Function called for each address (or address status change) that
- * the validation module is aware of (for the given target).
- *
- * @param cls closure
- * @param public_key public key for the peer, never NULL
- * @param valid_until is ZERO if we never validated the address,
- *                    otherwise a time up to when we consider it (or was) valid
- * @param validation_block  is FOREVER if the address is for an unsupported plugin (from PEERINFO)
- *                          is ZERO if the address is considered valid (no validation needed)
- *                          otherwise a time in the future if we're currently denying re-validation
- * @param address the address
- */
-typedef void (*GST_ValidationChangedCallback) (void *cls,
-    const struct GNUNET_PeerIdentity *peer,
-    const struct GNUNET_HELLO_Address *address,
-    struct GNUNET_TIME_Absolute last_validation,
-    struct GNUNET_TIME_Absolute valid_until,
-    struct GNUNET_TIME_Absolute next_validation,
-    enum GNUNET_TRANSPORT_ValidationState state);
-
 /**
  * Start the validation subsystem.
  *
  * @param max_fds maximum number of fds to use
  */
 void
-GST_validation_start (GST_ValidationChangedCallback cb, void *cb_cls, unsigned int max_fds);
+GST_validation_start (unsigned int max_fds);
 
 
 /**
@@ -73,41 +52,45 @@ GST_validation_stop (void);
  * Based on this, the validation module will measure latency for the
  * address more or less often.
  *
- * @param address the address
- * @param session the session
- * @param in_use GNUNET_YES if we are now using the address for a connection,
- *               GNUNET_NO if we are no longer using the address for a connection
+ * @param address the address that we are now using (or not)
+ * @param in_use #GNUNET_YES if we are now using the address for a connection,
+ *               #GNUNET_NO if we are no longer using the address for a connection
  */
 void
 GST_validation_set_address_use (const struct GNUNET_HELLO_Address *address,
-                                struct Session *session,
                                 int in_use);
 
 
 /**
- * Query validation about the latest observed latency on a given
- * address.
+ * Function called to notify transport users that a neighbour peer changed its
+ * active address.
  *
- * @param sender peer
- * @param address the address
- * @param session session
- * @return observed latency of the address, FOREVER if the address was
- *         never successfully validated
+ * @param cls closure
+ * @param address address (never NULL)
+ * @param last_validation point in time when last validation was performed
+ * @param valid_until point in time how long address is valid
+ * @param next_validation point in time when next validation will be performed
+ * @param state state of validation notification
  */
-struct GNUNET_TIME_Relative
-GST_validation_get_address_latency (const struct GNUNET_PeerIdentity *sender,
-                                    const struct GNUNET_HELLO_Address *address,
-                                    struct Session *session);
+typedef void
+(*GST_ValidationChangedCallback) (void *cls,
+                                  const struct GNUNET_HELLO_Address *address,
+                                  struct GNUNET_TIME_Absolute last_validation,
+                                  struct GNUNET_TIME_Absolute valid_until,
+                                  struct GNUNET_TIME_Absolute next_validation,
+                                  enum GNUNET_TRANSPORT_ValidationState state);
+
 
 /**
  * Iterate over all iteration entries
  *
  * @param cb function to call
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
  */
 void
 GST_validation_iterate (GST_ValidationChangedCallback cb, void *cb_cls);
 
+
 /**
  * We've received a PING.  If appropriate, generate a PONG.
  *
@@ -121,7 +104,7 @@ int
 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
                             const struct GNUNET_MessageHeader *hdr,
                             const struct GNUNET_HELLO_Address *sender_address,
-                            struct Session *session);
+                            struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -148,6 +131,15 @@ int
 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
 
 
+/**
+ * Validate an individual address.
+ *
+ * @param address address we should try to validate
+ */
+void
+GST_validation_handle_address (const struct GNUNET_HELLO_Address *address);
+
+
 /**
  * Function called for each address (or address status change) that
  * the validation module is aware of (for the given target).
@@ -161,15 +153,11 @@ GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
  *                          otherwise a time in the future if we're currently denying re-validation
  * @param address the address
  */
-typedef void (*GST_ValidationAddressCallback) (void *cls,
-                                               const struct
-                                               GNUNET_CRYPTO_EddsaPublicKey *public_key,
-                                               struct GNUNET_TIME_Absolute
-                                               valid_until,
-                                               struct GNUNET_TIME_Absolute
-                                               validation_block,
-                                               const struct GNUNET_HELLO_Address
-                                               * address);
+typedef void
+(*GST_ValidationAddressCallback) (void *cls,
+                                  struct GNUNET_TIME_Absolute valid_until,
+                                  struct GNUNET_TIME_Absolute validation_block,
+                                  const struct GNUNET_HELLO_Address *address);
 
 
 /**
@@ -177,7 +165,7 @@ typedef void (*GST_ValidationAddressCallback) (void *cls,
  *
  * @param target peer information is requested for
  * @param cb function to call; will not be called after this function returns
- * @param cb_cls closure for 'cb'
+ * @param cb_cls closure for @a cb
  */
 void
 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,