more refactoring

1 files changed, 55 insertions, 6 deletions

diff --git a/src/transport/gnunet-service-transport_validation.h b/src/transport/gnunet-service-transport_validation.h
index 9768c425e..0d6e0ef5a 100644
--- a/src/transport/gnunet-service-transport_validation.h
+++ b/src/transport/gnunet-service-transport_validation.h
@@ -20,7 +20,7 @@
 
 /**
  * @file transport/gnunet-service-transport_validation.h
- * @brief plugin management API
+ * @brief address validation API
  * @author Christian Grothoff
  */
 #ifndef GNUNET_SERVICE_TRANSPORT_VALIDATION_H
@@ -31,33 +31,49 @@
 
 
 /**
- *
+ * Start the validation subsystem.
  */
 void 
 GST_validation_start (void);
 
 
 /**
- *
+ * Stop the validation subsystem.
  */
 void
 GST_validation_stop (void);
 
 
 /**
+ * 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
  */
-int
+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);
 
+
 /**
+ * We've received a PONG.  Check if it matches a pending PING and
+ * mark the respective address as confirmed.
  *
+ * @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
  */
-int
+void
 GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
                             const struct GNUNET_MessageHeader *hdr,
                             const char *plugin_name,
@@ -66,21 +82,36 @@ GST_validation_handle_pong (const struct GNUNET_PeerIdentity *sender,
 
 
 /**
+ * We've received a HELLO, check which addresses are new and trigger
+ * validation.
  *
+ * @param hello the HELLO we received
  */
 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 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
  */
 typedef void (*GST_ValidationAddressCallback)(void *cls,
                                               const struct GNUNET_PeerIdentity *target,
@@ -90,13 +121,31 @@ typedef void (*GST_ValidationAddressCallback)(void *cls,
                                               const void *plugin_address,
                                               size_t plugin_address_len);
 
+
+/**
+ * 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);