Main Page   Alphabetical List   Data Structures   File List   Data Fields   Globals  

gateway.h

Go to the documentation of this file.
00001 #ifndef GATEWAY_H_INCLUDED
00002 #define GATEWAY_H_INCLUDED
00003 #define GATEWAY_H_VERSION "$Id: gateway.h,v 2.0 2002/06/04 14:34:21 jongfoster Exp $"
00004 /* ******************************************************************
00005  * $Source: /cvsroot/ijbswa/current/src/gateway.h,v $
00006  * ******************************************************************
00007  *
00008  * Written by and Copyright (C) 2001 the SourceForge
00009  * Privoxy team. http://www.privoxy.org/
00010  * 
00011  * Based on the Internet Junkbuster originally written
00012  * by and Copyright (C) 1997 Anonymous Coders and
00013  * Junkbusters Corporation.  http://www.junkbusters.com
00014  * 
00015  * This program is free software; you can redistribute it
00016  * and/or modify it under the terms of the GNU General
00017  * Public License as published by the Free Software
00018  * Foundation; either version 2 of the License, or (at
00019  * your option) any later version.
00020  * 
00021  * This program is distributed in the hope that it will
00022  * be useful, but WITHOUT ANY WARRANTY; without even the
00023  * implied warranty of MERCHANTABILITY or FITNESS FOR A
00024  * PARTICULAR PURPOSE.  See the GNU General Public
00025  * License for more details.
00026  * 
00027  * The GNU General Public License should be included with
00028  * this file.  If not, you can view it at
00029  * http://www.gnu.org/copyleft/gpl.html
00030  * or write to the Free Software Foundation, Inc., 59
00031  * Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00032  * 
00033  * *****************************************************************/
00034 /**
00035  * @file
00036  *
00037  * Contains functions to connect to a server, possibly
00038  * using a "gateway" (i.e. HTTP proxy and/or SOCKS4
00039  * proxy).  Also contains the list of gateway types.
00040  * 
00041  *
00042  * $Log: gateway.h,v $
00043  * Revision 2.0  2002/06/04 14:34:21  jongfoster
00044  * Moving source files to src/
00045  * 
00046  * Revision 1.7  2002/03/26 22:29:54  swa
00047  * we have a new homepage!
00048  * 
00049  * Revision 1.6  2002/03/25 22:12:45  oes
00050  * Added fix for undefined INADDR_NONE on Solaris by Bart Schelstraete
00051  * 
00052  * Revision 1.5  2002/03/24 13:25:43  swa
00053  * name change related issues
00054  * 
00055  * Revision 1.4  2002/03/09 20:03:52  jongfoster
00056  * - Making various functions return int rather than size_t.
00057  *   (Undoing a recent change).  Since size_t is unsigned on
00058  *   Windows, functions like read_socket that return -1 on
00059  *   error cannot return a size_t.
00060  * 
00061  *   THIS WAS A MAJOR BUG - it caused frequent, unpredictable
00062  *   crashes, and also frequently caused JB to jump to 100%
00063  *   CPU and stay there.  (Because it thought it had just
00064  *   read ((unsigned)-1) == 4Gb of data...)
00065  * 
00066  * - The signature of write_socket has changed, it now simply
00067  *   returns success=0/failure=nonzero.
00068  * 
00069  * - Trying to get rid of a few warnings --with-debug on
00070  *   Windows, I've introduced a new type "jb_socket".  This is
00071  *   used for the socket file descriptors.  On Windows, this
00072  *   is SOCKET (a typedef for unsigned).  Everywhere else, it's
00073  *   an int.  The error value can't be -1 any more, so it's
00074  *   now JB_INVALID_SOCKET (which is -1 on UNIX, and in
00075  *   Windows it maps to the #define INVALID_SOCKET.)
00076  * 
00077  * - The signature of bind_port has changed.
00078  * 
00079  * Revision 1.3  2001/07/29 18:58:15  jongfoster
00080  * Removing nested #includes, adding forward declarations for needed
00081  * structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
00082  * 
00083  * Revision 1.2  2001/06/07 23:12:14  jongfoster
00084  * Removing gateways[] list - no longer used.
00085  * Replacing function pointer in struct gateway with a directly
00086  * called function forwarded_connect(), which can do the common
00087  * task of deciding whether to connect to the web server or HTTP
00088  * proxy.
00089  * Replacing struct gateway with struct forward_spec
00090  * 
00091  * Revision 1.1.1.1  2001/05/15 13:58:54  oes
00092  * Initial import of version 2.9.3 source tree
00093  * 
00094  * 
00095  */
00096 /* *****************************************************************/
00097 
00098 
00099 #ifdef __cplusplus
00100 extern "C" {
00101 #endif
00102 
00103 struct forward_spec;
00104 struct http_request;
00105 struct client_state;
00106 
00107 extern jb_socket forwarded_connect(const struct forward_spec * fwd, 
00108                                    struct http_request *http, 
00109                                    struct client_state *csp);
00110 
00111 /*
00112  * Solaris fix
00113  */
00114 #ifndef INADDR_NONE
00115 #define INADDR_NONE -1
00116 #endif
00117 
00118 /*
00119  * Revision control strings from this header and associated .c file
00120  */
00121 
00122 /** Version information about gateway.c. */
00123 extern const char gateway_rcs[];
00124 
00125 /** Version information about gateway.h. */
00126 extern const char gateway_h_rcs[];
00127 
00128 #ifdef __cplusplus
00129 } /* extern "C" */
00130 #endif
00131 
00132 #endif /* ndef GATEWAY_H_INCLUDED */
00133 
00134 /*
00135   Local Variables:
00136   tab-width: 3
00137   end:
00138 */

Generated on Tue Jun 4 18:54:48 2002 for Privoxy 3.1.1 by doxygen1.2.15