-doxygen fixes

[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 886a410935939e35e563355a0e47cda72c2d9ce8..609cb2822c35c85717ce75285b7634918b84f502 100644 (file)
--- a/src/include/gnunet_hello_lib.h
+++ b/src/include/gnunet_hello_lib.h
@@ -35,10 +35,19 @@ extern "C"
 #endif
 #endif
 
-#include "gnunet_common.h"
-#include "gnunet_crypto_lib.h"
+#include "gnunet_util_lib.h"
 
 
+/**
+ * Prefix that every HELLO URI must start with.
+ */
+#define GNUNET_HELLO_URI_PREFIX "gnunet://hello/"
+
+/**
+ * Prefix that every FRIEND HELLO URI must start with.
+ */
+#define GNUNET_FRIEND_HELLO_URI_PREFIX "gnunet://friend-hello/"
+
 /**
  * An address for communicating with a peer.  We frequently
  * need this tuple and the components cannot really be
@@ -50,7 +59,7 @@ struct GNUNET_HELLO_Address
 
   /**
    * For which peer is this an address?
-   */ 
+   */
   struct GNUNET_PeerIdentity peer;
 
   /**
@@ -83,9 +92,8 @@ struct GNUNET_HELLO_Address
  */
 struct GNUNET_HELLO_Address *
 GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
-                              const char *transport_name,
-                              const void *address,
-                              size_t address_length);
+                               const char *transport_name, const void *address,
+                               size_t address_length);
 
 
 /**
@@ -108,13 +116,21 @@ GNUNET_HELLO_address_copy (const struct GNUNET_HELLO_Address *address);
  */
 int
 GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
-                         const struct GNUNET_HELLO_Address *a2);
+                          const struct GNUNET_HELLO_Address *a2);
 
 
+/**
+ * Get the size of an address struct.
+ *
+ * @param address address
+ * @return the size
+ */
+size_t
+GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address);
 
 /**
  * Free an address.
- * 
+ *
  * @param addr address to free
  */
 #define GNUNET_HELLO_address_free(addr) GNUNET_free(addr)
@@ -129,6 +145,15 @@ GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
 struct GNUNET_HELLO_Message;
 
 
+/** Return HELLO type
+ *
+ * @param h HELLO Message to test
+ * @return GNUNET_YES or GNUNET_NO
+ */
+int
+GNUNET_HELLO_is_friend_only (const struct GNUNET_HELLO_Message *h);
+
+
 /**
  * Copy the given address information into
  * the given buffer using the format of HELLOs.
@@ -142,8 +167,7 @@ struct GNUNET_HELLO_Message;
  */
 size_t
 GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
-                          struct GNUNET_TIME_Absolute expiration,
-                          char *target,
+                          struct GNUNET_TIME_Absolute expiration, char *target,
                           size_t max);
 
 
@@ -168,13 +192,16 @@ typedef size_t (*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
  * expiration time and an iterator that spews the
  * transport addresses.
  *
+ * If friend only is set to GNUNET_YES we create a FRIEND_HELLO which will
+ * not be gossiped to other peers
+ *
  * @return the hello message
  */
 struct GNUNET_HELLO_Message *
-GNUNET_HELLO_create (const struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
-                     *publicKey,
+GNUNET_HELLO_create (const struct GNUNET_CRYPTO_EddsaPublicKey *publicKey,
                      GNUNET_HELLO_GenerateAddressListCallback addrgen,
-                     void *addrgen_cls);
+                     void *addrgen_cls,
+                     int friend_only);
 
 
 /**
@@ -232,9 +259,11 @@ GNUNET_HELLO_equals (const struct GNUNET_HELLO_Message *h1,
  *         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 struct GNUNET_HELLO_Address *address,
-                                             struct GNUNET_TIME_Absolute expiration);
+typedef int (*GNUNET_HELLO_AddressIterator) (void *cls,
+                                             const struct GNUNET_HELLO_Address *
+                                             address,
+                                             struct GNUNET_TIME_Absolute
+                                             expiration);
 
 
 /**
@@ -296,8 +325,7 @@ GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message
  */
 int
 GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
-                      struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
-                      *publicKey);
+                      struct GNUNET_CRYPTO_EddsaPublicKey *publicKey);
 
 
 /**
@@ -323,6 +351,45 @@ GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
 struct GNUNET_MessageHeader *
 GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
 
+
+typedef struct GNUNET_TRANSPORT_PluginFunctions *
+(*GNUNET_HELLO_TransportPluginsFind) (const char *name);
+
+
+/**
+ * Compose a hello URI string from a hello message.
+ *
+ * @param hello Hello message
+ * @param plugins_find Function to find transport plugins by name
+ * @return Hello URI string
+ */
+char *
+GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
+                          GNUNET_HELLO_TransportPluginsFind plugins_find);
+
+/**
+ * Parse a hello URI string to a hello message.
+ *
+ * @param uri URI string to parse
+ * @param pubkey Pointer to struct where public key is parsed
+ * @param hello Pointer to struct where hello message is parsed
+ * @param plugins_find Function to find transport plugins by name
+ * @return GNUNET_OK on success, GNUNET_SYSERR if the URI was invalid, GNUNET_NO on other errors
+ */
+int
+GNUNET_HELLO_parse_uri (const char *uri,
+                        struct GNUNET_CRYPTO_EddsaPublicKey *pubkey,
+                        struct GNUNET_HELLO_Message **hello,
+                        GNUNET_HELLO_TransportPluginsFind plugins_find);
+
+#if 0                           /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+
 /* ifndef GNUNET_HELLO_LIB_H */
 #endif
 /* end of gnunet_hello_lib.h */