- opaque mq structs
[oweals/gnunet.git] / src / transport / gnunet-service-transport_validation.h
index 0d6e0ef5aeed2fb02e40ebad18e99a924eacfd35..929e97a5ca2168b9590f166914c398d648d308d2 100644 (file)
 #define GNUNET_SERVICE_TRANSPORT_VALIDATION_H
 
 #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);
 
 
 /**
@@ -44,22 +48,53 @@ 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 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 line line of caller just for DEBUGGING!
+ */
+void
+GST_validation_set_address_use (const struct GNUNET_HELLO_Address *address,
+                                struct Session *session,
+                                int in_use,
+                                int line);
+
+
+/**
+ * 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);
+
+
 /**
  * We've received a PING.  If appropriate, generate a PONG.
  *
  * @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 as known to the plugin, NULL
- *                       if we did not initiate the connection
- * @param sender_address_len number of bytes in sender_address
+ * @param sender_address address of the sender, NULL if we did not initiate
+ * @param session session we got the PING from
  */
 void
 GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
-                           const struct GNUNET_MessageHeader *hdr,
-                           const char *plugin_name,
-                           const void *sender_address,
-                           size_t sender_address_len);
+                            const struct GNUNET_MessageHeader *hdr,
+                            const struct GNUNET_HELLO_Address *sender_address,
+                            struct Session *session);
 
 
 /**
@@ -68,17 +103,10 @@ GST_validation_handle_ping (const struct GNUNET_PeerIdentity *sender,
  *
  * @param sender peer sending the PONG
  * @param hdr the PONG
- * @param plugin_name name of plugin that received the PONG
- * @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_pong (const struct GNUNET_PeerIdentity *sender,
-                           const struct GNUNET_MessageHeader *hdr,
-                           const char *plugin_name,
-                           const void *sender_address,
-                           size_t sender_address_len);
+                            const struct GNUNET_MessageHeader *hdr);
 
 
 /**
@@ -91,64 +119,41 @@ void
 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
 
 
-/**
- * Opaque handle to stop incremental validation address callbacks.
- */
-struct GST_ValidationIteratorContext;
-
-
 /**
  * Function called for each address (or address status change) that
  * the validation module is aware of (for the given target).
  *
  * @param cls closure
- * @param target peer this change is about, never NULL
- * @param last_validated_at is FOREVER if the address has not been validated (we're currently checking)
- *                          is ZERO if the address was validated a long time ago (from PEERINFO)
- *                          is a time in the past if this process validated the address
+ * @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)
- *                          is 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
+ *                          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_PeerIdentity *target,
-                                             struct GNUNET_TIME_Absolute last_validated_at,
-                                             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,
+                                               const struct
+                                               GNUNET_CRYPTO_EccPublicKeyBinaryEncoded
+                                               * public_key,
+                                               struct GNUNET_TIME_Absolute
+                                               valid_until,
+                                               struct GNUNET_TIME_Absolute
+                                               validation_block,
+                                               const struct GNUNET_HELLO_Address
+                                               * address);
 
 
 /**
  * Call the given function for each address for the given target.
- * Can either give a snapshot (synchronous API) or be continuous.
  *
  * @param target peer information is requested for
- * @param snapshot_only GNUNET_YES to iterate over addresses once, GNUNET_NO to
- *                      continue to give information about addresses as it evolves
  * @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
- */
-struct GST_ValidationIteratorContext *
-GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
-                             int snapshot_only,
-                             GST_ValidationAddressCallback cb,
-                             void *cb_cls);
-
-
-/**
- * Cancel an active validation address iteration.
- *
- * @param ctx the context of the operation that is cancelled
  */
 void
-GST_validation_get_addresses_cancel (struct GST_ValidationIteratorContext *ctx);
-
+GST_validation_get_addresses (const struct GNUNET_PeerIdentity *target,
+                              GST_ValidationAddressCallback cb, void *cb_cls);
 
 
 #endif