allow lads.myspacecdn.com
[privoxy.git] / gateway.h
1 #ifndef GATEWAY_H_INCLUDED
2 #define GATEWAY_H_INCLUDED
3 #define GATEWAY_H_VERSION "$Id: gateway.h,v 1.11 2008/11/13 09:08:42 fabiankeil 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://www.privoxy.org/
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.11  2008/11/13 09:08:42  fabiankeil
40  *    Add new config option: keep-alive-timeout.
41  *
42  *    Revision 1.10  2008/10/09 18:21:41  fabiankeil
43  *    Flush work-in-progress changes to keep outgoing connections
44  *    alive where possible. Incomplete and mostly #ifdef'd out.
45  *
46  *    Revision 1.9  2006/07/18 14:48:46  david__schmidt
47  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
48  *    with what was really the latest development (the v_3_0_branch branch)
49  *
50  *    Revision 1.7  2002/03/26 22:29:54  swa
51  *    we have a new homepage!
52  *
53  *    Revision 1.6  2002/03/25 22:12:45  oes
54  *    Added fix for undefined INADDR_NONE on Solaris by Bart Schelstraete
55  *
56  *    Revision 1.5  2002/03/24 13:25:43  swa
57  *    name change related issues
58  *
59  *    Revision 1.4  2002/03/09 20:03:52  jongfoster
60  *    - Making various functions return int rather than size_t.
61  *      (Undoing a recent change).  Since size_t is unsigned on
62  *      Windows, functions like read_socket that return -1 on
63  *      error cannot return a size_t.
64  *
65  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
66  *      crashes, and also frequently caused JB to jump to 100%
67  *      CPU and stay there.  (Because it thought it had just
68  *      read ((unsigned)-1) == 4Gb of data...)
69  *
70  *    - The signature of write_socket has changed, it now simply
71  *      returns success=0/failure=nonzero.
72  *
73  *    - Trying to get rid of a few warnings --with-debug on
74  *      Windows, I've introduced a new type "jb_socket".  This is
75  *      used for the socket file descriptors.  On Windows, this
76  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
77  *      an int.  The error value can't be -1 any more, so it's
78  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
79  *      Windows it maps to the #define INVALID_SOCKET.)
80  *
81  *    - The signature of bind_port has changed.
82  *
83  *    Revision 1.3  2001/07/29 18:58:15  jongfoster
84  *    Removing nested #includes, adding forward declarations for needed
85  *    structures, and changing the #define _FILENAME_H to FILENAME_H_INCLUDED.
86  *
87  *    Revision 1.2  2001/06/07 23:12:14  jongfoster
88  *    Removing gateways[] list - no longer used.
89  *    Replacing function pointer in struct gateway with a directly
90  *    called function forwarded_connect(), which can do the common
91  *    task of deciding whether to connect to the web server or HTTP
92  *    proxy.
93  *    Replacing struct gateway with struct forward_spec
94  *
95  *    Revision 1.1.1.1  2001/05/15 13:58:54  oes
96  *    Initial import of version 2.9.3 source tree
97  *
98  *
99  *********************************************************************/
100 \f
101
102 #ifdef __cplusplus
103 extern "C" {
104 #endif
105
106 struct forward_spec;
107 struct http_request;
108 struct client_state;
109
110 extern jb_socket forwarded_connect(const struct forward_spec * fwd, 
111                                    struct http_request *http, 
112                                    struct client_state *csp);
113 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
114
115 /*
116  * Default number of seconds after which an
117  * open connection will no longer be reused.
118  */
119 #define DEFAULT_KEEP_ALIVE_TIMEOUT 180
120
121 extern void set_keep_alive_timeout(int timeout);
122 extern void initialize_reusable_connections(void);
123 extern void forget_connection(jb_socket sfd);
124 extern void remember_connection(jb_socket sfd,
125                                 const struct http_request *http,
126                                 const struct forward_spec *fwd);
127 extern int close_unusable_connections(void);
128 #endif /* FEATURE_CONNECTION_KEEP_ALIVE */
129
130
131 /*
132  * Solaris fix
133  */
134 #ifndef INADDR_NONE
135 #define INADDR_NONE -1
136 #endif
137
138 /*
139  * Revision control strings from this header and associated .c file
140  */
141 extern const char gateway_rcs[];
142 extern const char gateway_h_rcs[];
143
144 #ifdef __cplusplus
145 } /* extern "C" */
146 #endif
147
148 #endif /* ndef GATEWAY_H_INCLUDED */
149
150 /*
151   Local Variables:
152   tab-width: 3
153   end:
154 */