gateway.h

   1 #ifndef GATEWAY_H_INCLUDED
   2 #define GATEWAY_H_INCLUDED
   3 #define GATEWAY_H_VERSION "$Id: gateway.h,v 1.4 2002/03/09 20:03:52 jongfoster Exp $"
   4 /*********************************************************************
   5  *
   6  * File        :  $Source: /cvsroot/ijbswa/current/gateway.h,v $
   7  *
   8  * Purpose     :  Contains functions to connect to a server, possibly
   9  *                using a "gateway" (i.e. HTTP proxy and/or SOCKS4
  10  *                proxy).  Also contains the list of gateway types.
  11  *
  12  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  13  *                Privoxy team.  http://ijbswa.sourceforge.net
  14  *
  15  *                Based on the Internet Junkbuster originally written
  16  *                by and Copyright (C) 1997 Anonymous Coders and
  17  *                Junkbusters Corporation.  http://www.junkbusters.com
  18  *
  19  *                This program is free software; you can redistribute it
  20  *                and/or modify it under the terms of the GNU General
  21  *                Public License as published by the Free Software
  22  *                Foundation; either version 2 of the License, or (at
  23  *                your option) any later version.
  24  *
  25  *                This program is distributed in the hope that it will
  26  *                be useful, but WITHOUT ANY WARRANTY; without even the
  27  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
  28  *                PARTICULAR PURPOSE.  See the GNU General Public
  29  *                License for more details.
  30  *
  31  *                The GNU General Public License should be included with
  32  *                this file.  If not, you can view it at
  33  *                http://www.gnu.org/copyleft/gpl.html
  34  *                or write to the Free Software Foundation, Inc., 59
  35  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  36  *
  37  * Revisions   :
  38  *    $Log: gateway.h,v $
  39  *    Revision 1.4  2002/03/09 20:03:52  jongfoster
  40  *    - Making various functions return int rather than size_t.
  41  *      (Undoing a recent change).  Since size_t is unsigned on
  42  *      Windows, functions like read_socket that return -1 on
  43  *      error cannot return a size_t.
  44  *
  45  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
  46  *      crashes, and also frequently caused JB to jump to 100%
  47  *      CPU and stay there.  (Because it thought it had just
  48  *      read ((unsigned)-1) == 4Gb of data...)
  49  *
  50  *    - The signature of write_socket has changed, it now simply
  51  *      returns success=0/failure=nonzero.
  52  *
  53  *    - Trying to get rid of a few warnings --with-debug on
  54  *      Windows, I've introduced a new type "jb_socket".  This is
  55  *      used for the socket file descriptors.  On Windows, this
  56  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
  57  *      an int.  The error value can't be -1 any more, so it's
  58  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
  59  *      Windows it maps to the #define INVALID_SOCKET.)
  60  *
  61  *    - The signature of bind_port has changed.
  62  *
  63  *    Revision 1.3  2001/07/29 18:58:15  jongfoster
  64  *    Removing nested #includes, adding forward declarations for needed
  65  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
  66  *
  67  *    Revision 1.2  2001/06/07 23:12:14  jongfoster
  68  *    Removing gateways[] list - no longer used.
  69  *    Replacing function pointer in struct gateway with a directly
  70  *    called function forwarded_connect(), which can do the common
  71  *    task of deciding whether to connect to the web server or HTTP
  72  *    proxy.
  73  *    Replacing struct gateway with struct forward_spec
  74  *
  75  *    Revision 1.1.1.1  2001/05/15 13:58:54  oes
  76  *    Initial import of version 2.9.3 source tree
  77  *
  78  *
  79  *********************************************************************/
  80 \f
  81
  82 #ifdef __cplusplus
  83 extern "C" {
  84 #endif
  85
  86 struct forward_spec;
  87 struct http_request;
  88 struct client_state;
  89
  90 extern jb_socket forwarded_connect(const struct forward_spec * fwd,
  91                                    struct http_request *http,
  92                                    struct client_state *csp);
  93
  94 /* Revision control strings from this header and associated .c file */
  95 extern const char gateway_rcs[];
  96 extern const char gateway_h_rcs[];
  97
  98 #ifdef __cplusplus
  99 } /* extern "C" */
 100 #endif
 101
 102 #endif /* ndef GATEWAY_H_INCLUDED */
 103
 104 /*
 105   Local Variables:
 106   tab-width: 3
 107   end:
 108 */