src/transport/plugin_transport_http_common.h

   1 /*
   2      This file is part of GNUnet
   3      (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file transport/plugin_transport_http_common.c
  23  * @brief functionality shared by http client and server transport service plugin
  24  * @author Matthias Wachs
  25  */
  26
  27 #include "platform.h"
  28 #include "gnunet_common.h"
  29 #include "gnunet_transport_plugin.h"
  30 /**
  31  * Timeout values for testing
  32  */
  33 #define TESTING GNUNET_NO
  34
  35 #if TESTING
  36
  37 #define HTTP_SERVER_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
  38 #define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 3)
  39 #define CLIENT_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 7)
  40 #define SERVER_SESSION_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 7)
  41 #define TIMEOUT_LOG GNUNET_ERROR_TYPE_DEBUG
  42
  43 #else
  44
  45 #define HTTP_SERVER_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  46 #define HTTP_CLIENT_NOT_VALIDATED_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 15)
  47 #define CLIENT_SESSION_TIMEOUT GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
  48 #define SERVER_SESSION_TIMEOUT GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT
  49 #define TIMEOUT_LOG GNUNET_ERROR_TYPE_DEBUG
  50
  51 #endif
  52
  53 struct SplittedHTTPAddress;
  54
  55 struct SplittedHTTPAddress *
  56 http_split_address (const char * addr);
  57
  58 /**
  59  * Convert the transports address to a nice, human-readable
  60  * format.
  61  *
  62  * @param cls closure
  63  * @param type name of the transport that generated the address
  64  * @param addr one of the addresses of the host, NULL for the last address
  65  *        the specific address format depends on the transport
  66  * @param addrlen length of the address
  67  * @param numeric should (IP) addresses be displayed in numeric form?
  68  * @param timeout after how long should we give up?
  69  * @param asc function to call on each string
  70  * @param asc_cls closure for asc
  71  */
  72 void
  73 http_common_plugin_address_pretty_printer (void *cls, const char *type,
  74                                         const void *addr, size_t addrlen,
  75                                         int numeric,
  76                                         struct GNUNET_TIME_Relative timeout,
  77                                         GNUNET_TRANSPORT_AddressStringCallback
  78                                         asc, void *asc_cls);
  79
  80 /**
  81  * Function called for a quick conversion of the binary address to
  82  * a numeric address.  Note that the caller must not free the
  83  * address and that the next call to this function is allowed
  84  * to override the address again.
  85  *
  86  * @param cls closure
  87  * @param addr binary address
  88  * @param addrlen length of the address
  89  * @return string representing the same address
  90  */
  91 const char *
  92 http_common_plugin_address_to_string (void *cls,
  93                                       const void *addr,
  94                                       size_t addrlen);
  95
  96 /**
  97  * Function called to convert a string address to
  98  * a binary address.
  99  *
 100  * @param cls closure ('struct Plugin*')
 101  * @param addr string address
 102  * @param addrlen length of the address
 103  * @param buf location to store the buffer
 104  *        If the function returns GNUNET_SYSERR, its contents are undefined.
 105  * @param added length of created address
 106  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 107  */
 108 int
 109 http_common_plugin_string_to_address (void *cls,
 110                                       const char *addr,
 111                                       uint16_t addrlen,
 112                                       void **buf,
 113                                       size_t *added);
 114
 115
 116 /**
 117  * Create a HTTP address from a socketaddr
 118  *
 119  * @param protocol protocol
 120  * @param addr sockaddr * address
 121  * @param addrlen length of the address
 122  * @return the string
 123  */
 124 char *
 125 http_common_address_from_socket (const char *protocol,
 126                                  const struct sockaddr *addr,
 127                                  socklen_t addrlen);
 128
 129 /**
 130  * Create a socketaddr from a HTTP address
 131  *
 132  * @param addr sockaddr * address
 133  * @param addrlen length of the address
 134  * @param res the result:
 135  * GNUNET_SYSERR, invalid input,
 136  * GNUNET_YES: could convert to ip,
 137  * GNUNET_NO: valid input but could not convert to ip (hostname?)
 138  * @return the string
 139  */
 140 struct sockaddr *
 141 http_common_socket_from_address (const void *addr, size_t addrlen, int *res);
 142
 143 /**
 144  * Get the length of an address
 145  *
 146  * @param addr address
 147  * @return the size
 148  */
 149 size_t
 150 http_common_address_get_size (void *addr);
 151
 152
 153 /**
 154  * Compare addr1 to addr2
 155  *
 156  * @param addr1 address1
 157  * @param addrlen1 address 1 length
 158  * @param addr2 address2
 159  * @param addrlen2 address 2 length
 160  * @return GNUNET_YES if equal, GNUNET_NO else
 161  */
 162 size_t
 163 http_common_cmp_addresses (const void *addr1, size_t addrlen1, const void *addr2, size_t addrlen2);
 164 /* end of plugin_transport_http_common.c */