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
  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 /**
  54  * Convert the transports address to a nice, human-readable
  55  * format.
  56  *
  57  * @param cls closure
  58  * @param type name of the transport that generated the address
  59  * @param addr one of the addresses of the host, NULL for the last address
  60  *        the specific address format depends on the transport
  61  * @param addrlen length of the address
  62  * @param numeric should (IP) addresses be displayed in numeric form?
  63  * @param timeout after how long should we give up?
  64  * @param asc function to call on each string
  65  * @param asc_cls closure for asc
  66  */
  67 void
  68 http_common_plugin_address_pretty_printer (void *cls, const char *type,
  69                                         const void *addr, size_t addrlen,
  70                                         int numeric,
  71                                         struct GNUNET_TIME_Relative timeout,
  72                                         GNUNET_TRANSPORT_AddressStringCallback
  73                                         asc, void *asc_cls);
  74
  75 /**
  76  * Function called for a quick conversion of the binary address to
  77  * a numeric address.  Note that the caller must not free the
  78  * address and that the next call to this function is allowed
  79  * to override the address again.
  80  *
  81  * @param cls closure
  82  * @param addr binary address
  83  * @param addrlen length of the address
  84  * @return string representing the same address
  85  */
  86 const char *
  87 http_common_plugin_address_to_string (void *cls,
  88                                       const void *addr,
  89                                       size_t addrlen);
  90
  91 /**
  92  * Function called to convert a string address to
  93  * a binary address.
  94  *
  95  * @param cls closure ('struct Plugin*')
  96  * @param addr string address
  97  * @param addrlen length of the address
  98  * @param buf location to store the buffer
  99  *        If the function returns GNUNET_SYSERR, its contents are undefined.
 100  * @param added length of created address
 101  * @return GNUNET_OK on success, GNUNET_SYSERR on failure
 102  */
 103 int
 104 http_common_plugin_string_to_address (void *cls,
 105                                       const char *addr,
 106                                       uint16_t addrlen,
 107                                       void **buf,
 108                                       size_t *added);
 109
 110
 111 /**
 112  * Create a HTTP address from a socketaddr
 113  *
 114  * @param protocol protocol
 115  * @param addr sockaddr * address
 116  * @param addrlen length of the address
 117  * @return the string
 118  */
 119 char *
 120 http_common_address_from_socket (const char *protocol,
 121                                  const struct sockaddr *addr,
 122                                  socklen_t addrlen);
 123
 124 /**
 125  * Create a socketaddr from a HTTP address
 126  *
 127  * @param addr sockaddr * address
 128  * @param addrlen length of the address
 129  * @param res the result:
 130  * GNUNET_SYSERR, invalid input,
 131  * GNUNET_YES: could convert to ip,
 132  * GNUNET_NO: valid input but could not convert to ip (hostname?)
 133  * @return the string
 134  */
 135 struct sockaddr *
 136 http_common_socket_from_address (const void *addr, size_t addrlen, int *res);
 137
 138 /**
 139  * Get the length of an address
 140  *
 141  * @param addr address
 142  * @return the size
 143  */
 144 size_t
 145 http_common_address_get_size (void *addr);
 146
 147
 148 /**
 149  * Compare addr1 to addr2
 150  *
 151  * @param addr1 address1
 152  * @param addrlen1 address 1 length
 153  * @param addr2 address2
 154  * @param addrlen2 address 2 length
 155  * @return GNUNET_YES if equal, GNUNET_NO else
 156  */
 157 size_t
 158 http_common_cmp_addresses (const void *addr1, size_t addrlen1, const void *addr2, size_t addrlen2);
 159 /* end of plugin_transport_http_common.c */