Check that you are not present in trail twice
[oweals/gnunet.git] / src / transport / gnunet-service-transport_validation.h
index 46d3162c4d7ce1c978c4f0d69556b26d9e0db038..df2ef0ee82c66e956c31c40eeab5bf4f2c518201 100644 (file)
@@ -31,7 +31,6 @@
 #include "gnunet_util_lib.h"
 #include "gnunet_hello_lib.h"
 
-
 /**
  * Start the validation subsystem.
  *
@@ -55,15 +54,13 @@ GST_validation_stop (void);
  *
  * @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!
+ * @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,
-                                int line);
+                                int in_use);
 
 
 /**
@@ -82,6 +79,38 @@ GST_validation_get_address_latency (const struct GNUNET_PeerIdentity *sender,
                                     struct Session *session);
 
 
+/**
+ * Function called to notify transport users that a neighbour peer changed its
+ * active address.
+ *
+ * @param cls closure
+ * @param peer peer this update is about (never NULL)
+ * @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_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);
+
+
+/**
+ * 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);
+
+
 /**
  * We've received a PING.  If appropriate, generate a PONG.
  *
@@ -89,8 +118,9 @@ GST_validation_get_address_latency (const struct GNUNET_PeerIdentity *sender,
  * @param hdr the PING
  * @param sender_address address of the sender, NULL if we did not initiate
  * @param session session we got the PING from
+ * @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 struct GNUNET_HELLO_Address *sender_address,
@@ -103,8 +133,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);
 
@@ -114,8 +145,9 @@ 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
+int
 GST_validation_handle_hello (const struct GNUNET_MessageHeader *hello);
 
 
@@ -132,15 +164,12 @@ 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_EccPublicKey *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,
+                                  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);
 
 
 /**
@@ -148,7 +177,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,