/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010, 2011 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010, 2011 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
*/
#define GNUNET_FRIEND_HELLO_URI_PREFIX "gnunet://friend-hello/"
+/**
+ * Separator used in HELLO URI
+ */
+#define GNUNET_HELLO_URI_SEP '+'
+
/**
* Additional local information about an address
*/
struct GNUNET_PeerIdentity peer;
- /**
- * Extended information about address
- *
- * This field contains additional #GNUNET_HELLO_AddressInfo flags e.g.
- * to indicate an address is inbound and cannot be used to initiate an
- * outbound connection.
- *
- * These information are only valid for the local peer and are not serialized
- * when a #GNUNET_HELLO_Message is created
- */
- enum GNUNET_HELLO_AddressInfo local_info;
-
/**
* Name of the transport plugin enabling the communication using
* this address.
const void *address;
/**
- * Number of bytes in 'address'.
+ * Number of bytes in @e address.
*/
size_t address_length;
+ /**
+ * Extended information about address
+ *
+ * This field contains additional #GNUNET_HELLO_AddressInfo flags e.g.
+ * to indicate an address is inbound and cannot be used to initiate an
+ * outbound connection.
+ *
+ * These information are only valid for the local peer and are not serialized
+ * when a #GNUNET_HELLO_Message is created
+ */
+ enum GNUNET_HELLO_AddressInfo local_info;
+
};
+
/**
* Allocate an address struct.
*
* @param peer the peer
* @param transport_name plugin name
* @param address binary address
- * @param address_length number of bytes in 'address'
+ * @param address_length number of bytes in @a address
+ * @param local_info additional local information for the address
* @return the address struct
*/
struct GNUNET_HELLO_Address *
GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
- const char *transport_name, const void *address,
+ const char *transport_name,
+ const void *address,
size_t address_length,
enum GNUNET_HELLO_AddressInfo local_info);
+
/**
* Copy an address struct.
*
*
* @param a1 first address
* @param a2 second address
- * @return 0 if the addresses are equal, -1 if a1<a2, 1 if a1>a2.
+ * @return 0 if the addresses are equal, -1 if @a a1< @a a2, 1 if @a a1> @a a2.
*/
int
GNUNET_HELLO_address_cmp (const struct GNUNET_HELLO_Address *a1,
const struct GNUNET_HELLO_Address *a2);
+
/**
* Get the size of an address struct.
*
size_t
GNUNET_HELLO_address_get_size (const struct GNUNET_HELLO_Address *address);
+
/**
* Check if an address has a local option set
*
* @param address the address to check
* @param option the respective option to check for
- * @return GNUNET_YES or GNUNET_NO
+ * @return #GNUNET_YES or #GNUNET_NO
*/
int
-GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address * address,
- enum GNUNET_HELLO_AddressInfo option);
+GNUNET_HELLO_address_check_option (const struct GNUNET_HELLO_Address *address,
+ enum GNUNET_HELLO_AddressInfo option);
/**
/**
* A HELLO message is used to exchange information about
* transports with other peers. This struct is guaranteed
- * to start with a "GNUNET_MessageHeader", everything else
+ * to start with a `struct GNUNET_MessageHeader`, everything else
* should be internal to the HELLO library.
*/
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);
* @param cls closure
* @param max maximum number of bytes that can be written to @a buf
* @param buf where to write the address information
- * @return number of bytes written, 0 to signal the
+ * @return number of bytes written or 0, #GNUNET_SYSERR to signal the
* end of the iteration.
*/
-typedef size_t
+typedef ssize_t
(*GNUNET_HELLO_GenerateAddressListCallback) (void *cls,
size_t max,
void *buf);
* 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
+ * If friend only is set to #GNUNET_YES we create a FRIEND_HELLO which
+ * will not be gossiped to other peers.
*
+ * @param publicKey public key to include in the HELLO
+ * @param addrgen callback to invoke to get addresses
+ * @param addrgen_cls closure for @a addrgen
+ * @param friend_only should the returned HELLO be only visible to friends?
* @return the hello message
*/
struct GNUNET_HELLO_Message *
/**
* Return the size of the given HELLO message.
+ *
* @param hello to inspect
* @return the size, 0 if HELLO is invalid
*/
* @param expiration_limit ignore addresses in old_hello
* that expired before the given time stamp
* @param it iterator to call on each address
- * @param it_cls closure for it
+ * @param it_cls closure for @a it
*/
void
GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message *new_hello,
GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
+/**
+ * FIXME.
+ *
+ * @param name
+ */
typedef struct GNUNET_TRANSPORT_PluginFunctions *
(*GNUNET_HELLO_TransportPluginsFind) (const char *name);
GNUNET_HELLO_compose_uri (const struct GNUNET_HELLO_Message *hello,
GNUNET_HELLO_TransportPluginsFind plugins_find);
+
/**
* Parse a hello URI string to a hello message.
*
projects / oweals / gnunet.git / blobdiff