Add a note to update the code status before releasing a new version.
[privoxy.git] / gateway.h
1 #ifndef GATEWAY_H_INCLUDED
2 #define GATEWAY_H_INCLUDED
3 #define GATEWAY_H_VERSION "$Id: gateway.h,v 1.22 2012/10/23 10:16:52 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-2009 the
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  *********************************************************************/
38
39
40 struct forward_spec;
41 struct http_request;
42 struct client_state;
43
44 extern jb_socket forwarded_connect(const struct forward_spec * fwd,
45                                    struct http_request *http,
46                                    struct client_state *csp);
47
48 /*
49  * Default number of seconds after which an
50  * open connection will no longer be reused.
51  */
52 #define DEFAULT_KEEP_ALIVE_TIMEOUT 180
53
54 #ifdef FEATURE_CONNECTION_SHARING
55 extern void set_keep_alive_timeout(unsigned int timeout);
56 extern void initialize_reusable_connections(void);
57 extern void forget_connection(jb_socket sfd);
58 extern void remember_connection(const struct reusable_connection *connection);
59 extern int close_unusable_connections(void);
60 #endif /* FEATURE_CONNECTION_SHARING */
61
62 extern void mark_connection_closed(struct reusable_connection *closed_connection);
63 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
64 extern int connection_destination_matches(const struct reusable_connection *connection,
65                                           const struct http_request *http,
66                                           const struct forward_spec *fwd);
67 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
68
69 /*
70  * Revision control strings from this header and associated .c file
71  */
72 extern const char gateway_rcs[];
73 extern const char gateway_h_rcs[];
74
75 #endif /* ndef GATEWAY_H_INCLUDED */
76
77 /*
78   Local Variables:
79   tab-width: 3
80   end:
81 */