Initial keep-alive support for the client socket.
[privoxy.git] / jbsockets.h
1 #ifndef JBSOCKETS_H_INCLUDED
2 #define JBSOCKETS_H_INCLUDED
3 #define JBSOCKETS_H_VERSION "$Id: jbsockets.h,v 1.14 2008/12/20 14:53:55 fabiankeil Exp $"
4 /*********************************************************************
5  *
6  * File        :  $Source: /cvsroot/ijbswa/current/jbsockets.h,v $
7  *
8  * Purpose     :  Contains wrappers for system-specific sockets code,
9  *                so that the rest of Junkbuster can be more
10  *                OS-independent.  Contains #ifdefs to make this work
11  *                on many platforms.
12  *
13  * Copyright   :  Written by and Copyright (C) 2001-2009 the
14  *                Privoxy team. http://www.privoxy.org/
15  *
16  *                Based on the Internet Junkbuster originally written
17  *                by and Copyright (C) 1997 Anonymous Coders and 
18  *                Junkbusters Corporation.  http://www.junkbusters.com
19  *
20  *                This program is free software; you can redistribute it 
21  *                and/or modify it under the terms of the GNU General
22  *                Public License as published by the Free Software
23  *                Foundation; either version 2 of the License, or (at
24  *                your option) any later version.
25  *
26  *                This program is distributed in the hope that it will
27  *                be useful, but WITHOUT ANY WARRANTY; without even the
28  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
29  *                PARTICULAR PURPOSE.  See the GNU General Public
30  *                License for more details.
31  *
32  *                The GNU General Public License should be included with
33  *                this file.  If not, you can view it at
34  *                http://www.gnu.org/copyleft/gpl.html
35  *                or write to the Free Software Foundation, Inc., 59
36  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
37  *
38  * Revisions   :
39  *    $Log: jbsockets.h,v $
40  *    Revision 1.14  2008/12/20 14:53:55  fabiankeil
41  *    Add config option socket-timeout to control the time
42  *    Privoxy waits for data to arrive on a socket. Useful
43  *    in case of stale ssh tunnels or when fuzz-testing.
44  *
45  *    Revision 1.13  2008/03/21 11:13:59  fabiankeil
46  *    Only gather host information if it's actually needed.
47  *    Also move the code out of accept_connection() so it's less likely
48  *    to delay other incoming connections if the host is misconfigured.
49  *
50  *    Revision 1.12  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.9.2.1  2002/05/26 23:41:27  joergs
55  *    AmigaOS: Fixed wrong type of len in write_socket()
56  *
57  *    Revision 1.9  2002/04/08 20:31:41  swa
58  *    fixed JB spelling
59  *
60  *    Revision 1.8  2002/03/26 22:29:54  swa
61  *    we have a new homepage!
62  *
63  *    Revision 1.7  2002/03/24 13:25:43  swa
64  *    name change related issues
65  *
66  *    Revision 1.6  2002/03/13 00:27:05  jongfoster
67  *    Killing warnings
68  *
69  *    Revision 1.5  2002/03/09 20:03:52  jongfoster
70  *    - Making various functions return int rather than size_t.
71  *      (Undoing a recent change).  Since size_t is unsigned on
72  *      Windows, functions like read_socket that return -1 on
73  *      error cannot return a size_t.
74  *
75  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
76  *      crashes, and also frequently caused JB to jump to 100%
77  *      CPU and stay there.  (Because it thought it had just
78  *      read ((unsigned)-1) == 4Gb of data...)
79  *
80  *    - The signature of write_socket has changed, it now simply
81  *      returns success=0/failure=nonzero.
82  *
83  *    - Trying to get rid of a few warnings --with-debug on
84  *      Windows, I've introduced a new type "jb_socket".  This is
85  *      used for the socket file descriptors.  On Windows, this
86  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
87  *      an int.  The error value can't be -1 any more, so it's
88  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
89  *      Windows it maps to the #define INVALID_SOCKET.)
90  *
91  *    - The signature of bind_port has changed.
92  *
93  *    Revision 1.4  2002/03/07 03:51:36  oes
94  *     - Improved handling of failed DNS lookups
95  *     - Fixed compiler warnings etc
96  *
97  *    Revision 1.3  2001/07/29 19:01:11  jongfoster
98  *    Changed _FILENAME_H to FILENAME_H_INCLUDED.
99  *    Added forward declarations for needed structures.
100  *
101  *    Revision 1.2  2001/06/07 23:06:09  jongfoster
102  *    The host parameter to connect_to() is now const.
103  *
104  *    Revision 1.1.1.1  2001/05/15 13:58:54  oes
105  *    Initial import of version 2.9.3 source tree
106  *
107  *
108  *********************************************************************/
109 \f
110
111 #include "project.h"
112
113 #ifdef __cplusplus
114 extern "C" {
115 #endif
116
117 struct client_state;
118
119 extern jb_socket connect_to(const char *host, int portnum, struct client_state *csp);
120 #ifdef AMIGA
121 extern int write_socket(jb_socket fd, const char *buf, ssize_t n);
122 #else
123 extern int write_socket(jb_socket fd, const char *buf, size_t n);
124 #endif
125 extern int read_socket(jb_socket fd, char *buf, int n);
126 extern int data_is_available(jb_socket fd, int seconds_to_wait);
127 extern void close_socket(jb_socket fd);
128
129 extern int bind_port(const char *hostnam, int portnum, jb_socket *pfd);
130 extern int accept_connection(struct client_state * csp, jb_socket fd);
131 extern void get_host_information(jb_socket afd, char **ip_address, char **hostname);
132
133 extern unsigned long resolve_hostname_to_ip(const char *host);
134
135 extern int socket_is_still_usable(jb_socket sfd);
136
137 /* Revision control strings from this header and associated .c file */
138 extern const char jbsockets_rcs[];
139 extern const char jbsockets_h_rcs[];
140
141 #ifdef __cplusplus
142 } /* extern "C" */
143 #endif
144
145 #endif /* ndef JBSOCKETS_H_INCLUDED */
146
147 /*
148   Local Variables:
149   tab-width: 3
150   end:
151 */