run indent twice, it alternates between two 'canonical' forms, also run whitespace...

[oweals/gnunet.git] / src / include / gnunet_hello_lib.h

diff --git a/src/include/gnunet_hello_lib.h b/src/include/gnunet_hello_lib.h
index 6191c4f7e794b7ca1f0d154c00b2efb5dd04c87d..0ec1be7d1233f8255685e9996fd2485d1df1b929 100644 (file)
--- a/src/include/gnunet_hello_lib.h
+++ b/src/include/gnunet_hello_lib.h
@@ -4,7 +4,7 @@
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
+     by the Free Software Foundation; either version 3, or (at your
      option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
@@ -63,8 +63,8 @@ struct GNUNET_HELLO_Message;
 size_t
 GNUNET_HELLO_add_address (const char *tname,
                           struct GNUNET_TIME_Absolute expiration,
-                          const void *addr,
-                          size_t addr_len, char *target, size_t max);
+                          const void *addr, uint16_t addr_len, char *target,
+                          size_t max);
 
 
 /**
@@ -78,9 +78,9 @@ GNUNET_HELLO_add_address (const char *tname,
  * @return number of bytes written, 0 to signal the
  *         end of the iteration.
  */
-typedef size_t
-  (*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
-                                               size_t max, void *buf);
+typedef size_t (*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
+                                                            size_t max,
+                                                            void *buf);
 
 
 /**
@@ -90,11 +90,11 @@ typedef size_t
  *
  * @return the hello message
  */
-struct GNUNET_HELLO_Message *GNUNET_HELLO_create (const struct
-                                                  GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
-                                                  *publicKey,
-                                                  GNUNET_HELLO_GenerateAddressListCallback
-                                                  addrgen, void *addrgen_cls);
+struct GNUNET_HELLO_Message *
+GNUNET_HELLO_create (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
+                     *publicKey,
+                     GNUNET_HELLO_GenerateAddressListCallback addrgen,
+                     void *addrgen_cls);
 
 
 /**
@@ -102,7 +102,8 @@ struct GNUNET_HELLO_Message *GNUNET_HELLO_create (const struct
  * @param hello to inspect
  * @return the size, 0 if HELLO is invalid
  */
-uint16_t GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello);
+uint16_t
+GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello);
 
 
 /**
@@ -114,12 +115,32 @@ uint16_t GNUNET_HELLO_size (const struct GNUNET_HELLO_Message *hello);
  * @param h2 the second HELLO message
  * @return the combined hello message
  */
-struct GNUNET_HELLO_Message *GNUNET_HELLO_merge (const struct
-                                                 GNUNET_HELLO_Message *h1,
-                                                 const struct
-                                                 GNUNET_HELLO_Message *h2);
+struct GNUNET_HELLO_Message *
+GNUNET_HELLO_merge (const struct GNUNET_HELLO_Message *h1,
+                    const struct GNUNET_HELLO_Message *h2);
 
 
+/**
+ * Test if two HELLO messages contain the same addresses.
+ * If they only differ in expiration time, the lowest
+ * expiration time larger than 'now' where they differ
+ * is returned.
+ *
+ * @param h1 first HELLO message
+ * @param h2 the second HELLO message
+ * @param now time to use for deciding which addresses have
+ *            expired and should not be considered at all
+ * @return absolute time forever if the two HELLOs are
+ *         totally identical; smallest timestamp >= now if
+ *         they only differ in timestamps;
+ *         zero if the some addresses with expirations >= now
+ *         do not match at all
+ */
+struct GNUNET_TIME_Absolute
+GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1,
+                     const struct GNUNET_HELLO_Message *h2,
+                     struct GNUNET_TIME_Absolute now);
+
 
 /**
  * Iterator callback to go over all addresses.
@@ -133,11 +154,10 @@ struct GNUNET_HELLO_Message *GNUNET_HELLO_merge (const struct
  *         GNUNET_NO to delete it from the HELLO
  *         GNUNET_SYSERR to stop iterating (but keep current address)
  */
-typedef int
-  (*GNUNET_HELLO_AddressIterator) (void *cls,
-                                   const char *tname,
-                                   struct GNUNET_TIME_Absolute expiration,
-                                   const void *addr, size_t addrlen);
+typedef int (*GNUNET_HELLO_AddressIterator) (void *cls, const char *tname,
+                                             struct GNUNET_TIME_Absolute
+                                             expiration, const void *addr,
+                                             uint16_t addrlen);
 
 
 /**
@@ -150,15 +170,12 @@ typedef int
  *         otherwise NULL will be returned
  * @param it iterator to call on each address
  * @param it_cls closure for it
+ * @return the modified HELLO or NULL
  */
-struct GNUNET_HELLO_Message *GNUNET_HELLO_iterate_addresses (const struct
-                                                             GNUNET_HELLO_Message
-                                                             *msg,
-                                                             int
-                                                             return_modified,
-                                                             GNUNET_HELLO_AddressIterator
-                                                             it,
-                                                             void *it_cls);
+struct GNUNET_HELLO_Message *
+GNUNET_HELLO_iterate_addresses (const struct GNUNET_HELLO_Message *msg,
+                                int return_modified,
+                                GNUNET_HELLO_AddressIterator it, void *it_cls);
 
 
 /**
@@ -205,7 +222,19 @@ GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
  */
 int
 GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
-                    struct GNUNET_PeerIdentity *peer);
+                     struct GNUNET_PeerIdentity *peer);
+
+
+/**
+ * Get the header from a HELLO message, used so other code
+ * can correctly send HELLO messages.
+ *
+ * @param hello the hello message
+ *
+ * @return header or NULL if the HELLO was malformed
+ */
+struct GNUNET_MessageHeader *
+GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
 
 /* ifndef GNUNET_HELLO_LIB_H */
 #endif