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