-more logging, avoid duplicate re-scheduling
[oweals/gnunet.git] / src / transport / gnunet-service-transport_validation.h
index bdf8bd9edb12f24de07f538aa71b05bb48fe3f77..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_statistics_service.h"
 #include "gnunet_transport_plugin.h"
 #include "gnunet_util_lib.h"
-
+#include "gnunet_hello_lib.h"
 
 /**
  * Start the validation subsystem.
+ *
+ * @param max_fds maximum number of fds to use
  */
-void GST_validation_start (void);
+void
+GST_validation_start (unsigned int max_fds);
 
 
 /**
  * Stop the validation subsystem.
  */
-void GST_validation_stop (void);
+void
+GST_validation_stop (void);
+
+
+/**
+ * Update if we are using an address for a connection actively right now.
+ * Based on this, the validation module will measure latency for the
+ * address more or less often.
+ *
+ * @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,
+                                int in_use);
+
+
+/**
+ * Function called to notify transport users that a neighbour peer changed its
+ * active address.
+ *
+ * @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
+ */
+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 @a cb
+ */
+void
+GST_validation_iterate (GST_ValidationChangedCallback cb, void *cb_cls);
 
 
 /**
@@ -48,19 +96,15 @@ void GST_validation_stop (void);
  *
  * @param sender peer sending the PING
  * @param hdr the PING
- * @param plugin_name name of plugin that received the PING
+ * @param sender_address address of the sender, NULL if we did not initiate
  * @param session session we got the PING from
- * @param sender_address address of the sender as known to the plugin, NULL
- *                       if we did not initiate the connection
- * @param sender_address_len number of bytes in sender_address
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
  */
-void
+int
 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
                             const struct GNUNET_MessageHeader *hdr,
-                            const char *plugin_name,
-                            struct Session *session,
-                            const void *sender_address,
-                            size_t sender_address_len);
+                            const struct GNUNET_HELLO_Address *sender_address,
+                            struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -69,8 +113,9 @@ GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
  *
  * @param sender peer sending the PONG
  * @param hdr the PONG
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
  */
-void
+int
 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
                             const struct GNUNET_MessageHeader *hdr);
 
@@ -80,8 +125,19 @@ GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
  * validation.
  *
  * @param hello the HELLO we received
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
  */
-void GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
+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);
 
 
 /**
@@ -90,29 +146,18 @@ void GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
  *
  * @param cls closure
  * @param public_key public key for the peer, never NULL
- * @param target peer this change is about, 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 plugin_name name of the plugin
- * @param plugin_address binary address
- * @param plugin_address_len length of address
+ * @param address the address
  */
-typedef void (*GST_ValidationAddressCallback) (void *cls,
-                                               const struct
-                                               GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
-                                               * public_key,
-                                               const struct GNUNET_PeerIdentity
-                                               * target,
-                                               struct GNUNET_TIME_Absolute
-                                               valid_until,
-                                               struct GNUNET_TIME_Absolute
-                                               validation_block,
-                                               const char *plugin_name,
-                                               const void *plugin_address,
-                                               size_t plugin_address_len);
+typedef void
+(*GST_ValidationAddressCallback) (void *cls,
+                                  struct GNUNET_TIME_Absolute valid_until,
+                                  struct GNUNET_TIME_Absolute validation_block,
+                                  const struct GNUNET_HELLO_Address *address);
 
 
 /**
@@ -120,9 +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
- *                             if snapshot_only is GNUNET_YES
- * @param cb_cls closure for 'cb'
- * @return context to cancel, NULL if 'snapshot_only' is GNUNET_YES
+ * @param cb_cls closure for @a cb
  */
 void
 GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,