/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2005, 2006, 2010 Christian Grothoff (and other contributing authors)
+ (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
#include "gnunet_common.h"
#include "gnunet_crypto_lib.h"
+
+/**
+ * An address for communicating with a peer. We frequently
+ * need this tuple and the components cannot really be
+ * separated. This is NOT the format that would be used
+ * on the wire.
+ */
+struct GNUNET_HELLO_Address
+{
+
+ /**
+ * For which peer is this an address?
+ */
+ struct GNUNET_PeerIdentity peer;
+
+ /**
+ * Name of the transport plugin enabling the communication using
+ * this address.
+ */
+ const char *transport_name;
+
+ /**
+ * Binary representation of the address (plugin-specific).
+ */
+ const void *address;
+
+ /**
+ * Number of bytes in 'address'.
+ */
+ size_t address_length;
+
+};
+
+
+/**
+ * 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'
+ * @return the address struct
+ */
+struct GNUNET_HELLO_Address *
+GNUNET_HELLO_address_allocate (const struct GNUNET_PeerIdentity *peer,
+ const char *transport_name, const void *address,
+ size_t address_length);
+
+
+/**
+ * Copy an address struct.
+ *
+ * @param address address to copy
+ * @return a copy of the address struct
+ */
+struct GNUNET_HELLO_Address *
+GNUNET_HELLO_address_copy (const struct GNUNET_HELLO_Address *address);
+
+
+/**
+ * Compare two addresses. Does NOT compare the peer identity,
+ * that is assumed already to match!
+ *
+ * @param a1 first address
+ * @param a2 second address
+ * @return 0 if the addresses are equal, -1 if a1<a2, 1 if a1>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.
+ *
+ * @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)
+
+
/**
* A HELLO message is used to exchange information about
* transports with other peers. This struct is guaranteed
* Copy the given address information into
* the given buffer using the format of HELLOs.
*
- * @param tname name of the transport plugin
+ * @param address address to add
* @param expiration expiration for the address
- * @param addr the address
- * @param addr_len length of the address in bytes
* @param target where to copy the address
* @param max maximum number of bytes to copy to target
* @return number of bytes copied, 0 if
* the target buffer was not big enough.
*/
-size_t GNUNET_HELLO_add_address (const char *tname,
- struct GNUNET_TIME_Absolute
- expiration, const void *addr,
- uint16_t addr_len, char *target,
- size_t max);
+size_t
+GNUNET_HELLO_add_address (const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_TIME_Absolute expiration, char *target,
+ size_t max);
/**
*
* @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);
/**
* @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);
/**
* @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);
/**
* @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
+ * @return absolute time forever if the two HELLOs are
* totally identical; smallest timestamp >= now if
- * they only differ in timestamps;
+ * 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);
+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.
*
* @param cls closure
- * @param tname name of the transport
+ * @param address the address
* @param expiration expiration time
- * @param addr the address
- * @param addrlen length of the address
* @return GNUNET_OK to keep the address,
* 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,
+typedef int (*GNUNET_HELLO_AddressIterator) (void *cls,
+ const struct GNUNET_HELLO_Address *
+ address,
struct GNUNET_TIME_Absolute
- expiration, const void *addr,
- uint16_t addrlen);
+ expiration);
+
+
+/**
+ * When does the last address in the given HELLO expire?
+ *
+ * @param msg HELLO to inspect
+ * @return time the last address expires, 0 if there are no addresses in the HELLO
+ */
+struct GNUNET_TIME_Absolute
+GNUNET_HELLO_get_last_expiration (const struct GNUNET_HELLO_Message *msg);
/**
* @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);
/**
* @param it iterator to call on each address
* @param it_cls closure for it
*/
-void GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message
- *new_hello,
- const struct GNUNET_HELLO_Message
- *old_hello,
- struct GNUNET_TIME_Absolute
- expiration_limit,
- GNUNET_HELLO_AddressIterator it,
- void *it_cls);
+void
+GNUNET_HELLO_iterate_new_addresses (const struct GNUNET_HELLO_Message
+ *new_hello,
+ const struct GNUNET_HELLO_Message
+ *old_hello,
+ struct GNUNET_TIME_Absolute
+ expiration_limit,
+ GNUNET_HELLO_AddressIterator it,
+ void *it_cls);
/**
* @param publicKey where to copy the public key information, can be NULL
* @return GNUNET_SYSERR if the HELLO was malformed
*/
-int GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
- struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
- *publicKey);
+int
+GNUNET_HELLO_get_key (const struct GNUNET_HELLO_Message *hello,
+ struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
+ *publicKey);
/**
* @param peer where to store the peer's identity
* @return GNUNET_SYSERR if the HELLO was malformed
*/
-int GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
- struct GNUNET_PeerIdentity *peer);
+int
+GNUNET_HELLO_get_id (const struct GNUNET_HELLO_Message *hello,
+ struct GNUNET_PeerIdentity *peer);
/**
*
* @return header or NULL if the HELLO was malformed
*/
-struct GNUNET_MessageHeader *GNUNET_HELLO_get_header (struct
- GNUNET_HELLO_Message
- *hello);
+struct GNUNET_MessageHeader *
+GNUNET_HELLO_get_header (struct GNUNET_HELLO_Message *hello);
/* ifndef GNUNET_HELLO_LIB_H */
#endif
projects / oweals / gnunet.git / blobdiff