/*
This file is part of GNUnet
- (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
+ (C) 2002-2013 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
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
-
/**
* @file transport/plugin_transport_http_common.c
* @brief functionality shared by http client and server transport service plugin
* @author Matthias Wachs
*/
-
#include "platform.h"
#include "gnunet_common.h"
#include "gnunet_transport_plugin.h"
#define HTTP_DEFAULT_PORT 80
#define HTTPS_DEFAULT_PORT 443
-enum HTTP_OPTIONS
+enum HTTP_ADDRESS_OPTIONS
{
- HTTP_OPTIONS_NONE = 0,
- HTTP_OPTIONS_VERIFY_CERTIFICATE = 1
+ HTTP_OPTIONS_NONE = 0,
+ HTTP_OPTIONS_VERIFY_CERTIFICATE = 1
};
*/
struct HttpAddress
{
- /**
- * Address options
- */
- uint32_t options;
-
- /**
- * Length of URL located after struct
- *
- */
- uint32_t urlen;
+ /**
+ * Address options
+ */
+ uint32_t options;
+
+ /**
+ * Length of URL located after struct
+ */
+ uint32_t urlen;
};
GNUNET_NETWORK_STRUCT_END
-struct SplittedHTTPAddress;
+/**
+ * Representation of HTTP URL split into its components.
+ */
+struct SplittedHTTPAddress
+{
+ char *protocol;
+ char *host;
+ char *path;
+ int port;
+};
+
+/**
+ * Split an HTTP address into protocol, hostname, port
+ * and path components.
+ */
struct SplittedHTTPAddress *
-http_split_address (const char * addr);
+http_split_address (const char *addr);
+
/**
* Convert the transports address to a nice, human-readable
* @param numeric should (IP) addresses be displayed in numeric form?
* @param timeout after how long should we give up?
* @param asc function to call on each string
- * @param asc_cls closure for asc
+ * @param asc_cls closure for @a asc
*/
void
-http_common_plugin_address_pretty_printer (void *cls, const char *type,
- const void *addr, size_t addrlen,
- int numeric,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_AddressStringCallback
- asc, void *asc_cls);
+http_common_plugin_address_pretty_printer (void *cls,
+ const char *type,
+ const void *addr,
+ size_t addrlen,
+ int numeric,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_AddressStringCallback asc,
+ void *asc_cls);
+
/**
* Function called for a quick conversion of the binary address to
* address and that the next call to this function is allowed
* to override the address again.
*
- * @param cls closure
- * @param plugin the plugin
+ * @param plugin name of the plugin
* @param addr binary address
- * @param addrlen length of the address
+ * @param addrlen length of @a addr
* @return string representing the same address
*/
const char *
-http_common_plugin_address_to_string (void *cls,
- char *plugin,
+http_common_plugin_address_to_string (const char *plugin,
const void *addr,
size_t addrlen);
+
/**
* Function called to convert a string address to
* a binary address.
*
- * @param cls closure ('struct Plugin*')
+ * @param cls closure (`struct Plugin*`)
* @param addr string address
* @param addrlen length of the address
* @param buf location to store the buffer
- * If the function returns GNUNET_SYSERR, its contents are undefined.
+ * If the function returns #GNUNET_SYSERR, its contents are undefined.
* @param added length of created address
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
int
http_common_plugin_string_to_address (void *cls,
* Create a HTTP address from a socketaddr
*
* @param protocol protocol
- * @param addr sockaddr * address
- * @param addrlen length of the address
+ * @param addr `sockaddr *` address
+ * @param addrlen length of the @a addr
* @return the string
*/
struct HttpAddress *
http_common_address_from_socket (const char *protocol,
- const struct sockaddr *addr,
- socklen_t addrlen);
+ const struct sockaddr *addr,
+ socklen_t addrlen);
+
/**
* Create a socketaddr from a HTTP address
*
- * @param addr sockaddr * address
- * @param addrlen length of the address
+ * @param addr a `sockaddr *` address
+ * @param addrlen length of the @a addr
* @param res the result:
- * GNUNET_SYSERR, invalid input,
- * GNUNET_YES: could convert to ip,
- * GNUNET_NO: valid input but could not convert to ip (hostname?)
+ * #GNUNET_SYSERR, invalid input,
+ * #GNUNET_YES: could convert to ip,
+ * #GNUNET_NO: valid input but could not convert to ip (hostname?)
* @return the string
*/
struct sockaddr *
-http_common_socket_from_address (const void *addr, size_t addrlen, int *res);
+http_common_socket_from_address (const void *addr,
+ size_t addrlen,
+ int *res);
+
const char *
-http_common_plugin_address_to_url (void *cls, const void *addr, size_t addrlen);
+http_common_plugin_address_to_url (void *cls,
+ const void *addr,
+ size_t addrlen);
+
/**
* Get the length of an address
* Compare addr1 to addr2
*
* @param addr1 address1
- * @param addrlen1 address 1 length
+ * @param addrlen1 length of @a address1
* @param addr2 address2
- * @param addrlen2 address 2 length
- * @return GNUNET_YES if equal, GNUNET_NO else
+ * @param addrlen2 length of @a address2
+ * @return #GNUNET_YES if equal, #GNUNET_NO else
*/
size_t
-http_common_cmp_addresses (const void *addr1, size_t addrlen1, const void *addr2, size_t addrlen2);
-/* end of plugin_transport_http_common.c */
+http_common_cmp_addresses (const void *addr1,
+ size_t addrlen1,
+ const void *addr2,
+ size_t addrlen2);
+
+/* end of plugin_transport_http_common.h */
projects / oweals / gnunet.git / blobdiff