- correct port
[oweals/gnunet.git] / src / transport / gnunet-service-transport_validation.h
index 86ede157649aa41ff92a382aeefb0564e1ee5dfb..9b1063be3740d3d05f432c3f1387ada27300e8eb 100644 (file)
 #include "gnunet_statistics_service.h"
 #include "gnunet_transport_plugin.h"
 #include "gnunet_util_lib.h"
+#include "gnunet_hello_lib.h"
 
 
 /**
  * Start the validation subsystem.
  */
-void GST_validation_start (void);
+void
+GST_validation_start (void);
 
 
 /**
  * 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
+ * @param session 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
+ */
+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.
+ *
+ * @param sender peer
+ * @param address the address
+ * @param session session
+ * @return observed latency of the address, FOREVER if the address was
+ *         never successfully validated
+ */
+struct GNUNET_TIME_Relative
+GST_validation_get_address_latency (const struct GNUNET_PeerIdentity *sender,
+                                    const struct GNUNET_HELLO_Address *address,
+                                    struct Session *session);
 
 
 /**
@@ -48,18 +82,14 @@ 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
  */
-void 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);
+void
+GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
+                            const struct GNUNET_MessageHeader *hdr,
+                            const struct GNUNET_HELLO_Address *sender_address,
+                            struct Session *session);
 
 
 /**
@@ -69,8 +99,9 @@ void GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
  * @param sender peer sending the PONG
  * @param hdr the PONG
  */
-void GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
-                                 const struct GNUNET_MessageHeader *hdr);
+void
+GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
+                            const struct GNUNET_MessageHeader *hdr);
 
 
 /**
@@ -79,7 +110,8 @@ void GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
  *
  * @param hello the HELLO we received
  */
-void GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
+void
+GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
 
 
 /**
@@ -88,29 +120,23 @@ 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);
+                                               const struct GNUNET_HELLO_Address
+                                               * address);
 
 
 /**
@@ -118,13 +144,11 @@ 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
  */
-void GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
-                                   GST_ValidationAddressCallback cb,
-                                   void *cb_cls);
+void
+GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
+                              GST_ValidationAddressCallback cb, void *cb_cls);
 
 
 #endif