8a58066acb25c0440af4d74b188e65e808f375d4
[privoxy.git] / jbsockets.h
1 #ifndef JBSOCKETS_H_INCLUDED
2 #define JBSOCKETS_H_INCLUDED
3 #define JBSOCKETS_H_VERSION "$Id: jbsockets.h,v 1.13 2008/03/21 11:13:59 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 the SourceForge
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.13  2008/03/21 11:13:59  fabiankeil
41  *    Only gather host information if it's actually needed.
42  *    Also move the code out of accept_connection() so it's less likely
43  *    to delay other incoming connections if the host is misconfigured.
44  *
45  *    Revision 1.12  2006/07/18 14:48:46  david__schmidt
46  *    Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
47  *    with what was really the latest development (the v_3_0_branch branch)
48  *
49  *    Revision 1.9.2.1  2002/05/26 23:41:27  joergs
50  *    AmigaOS: Fixed wrong type of len in write_socket()
51  *
52  *    Revision 1.9  2002/04/08 20:31:41  swa
53  *    fixed JB spelling
54  *
55  *    Revision 1.8  2002/03/26 22:29:54  swa
56  *    we have a new homepage!
57  *
58  *    Revision 1.7  2002/03/24 13:25:43  swa
59  *    name change related issues
60  *
61  *    Revision 1.6  2002/03/13 00:27:05  jongfoster
62  *    Killing warnings
63  *
64  *    Revision 1.5  2002/03/09 20:03:52  jongfoster
65  *    - Making various functions return int rather than size_t.
66  *      (Undoing a recent change).  Since size_t is unsigned on
67  *      Windows, functions like read_socket that return -1 on
68  *      error cannot return a size_t.
69  *
70  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
71  *      crashes, and also frequently caused JB to jump to 100%
72  *      CPU and stay there.  (Because it thought it had just
73  *      read ((unsigned)-1) == 4Gb of data...)
74  *
75  *    - The signature of write_socket has changed, it now simply
76  *      returns success=0/failure=nonzero.
77  *
78  *    - Trying to get rid of a few warnings --with-debug on
79  *      Windows, I've introduced a new type "jb_socket".  This is
80  *      used for the socket file descriptors.  On Windows, this
81  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
82  *      an int.  The error value can't be -1 any more, so it's
83  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
84  *      Windows it maps to the #define INVALID_SOCKET.)
85  *
86  *    - The signature of bind_port has changed.
87  *
88  *    Revision 1.4  2002/03/07 03:51:36  oes
89  *     - Improved handling of failed DNS lookups
90  *     - Fixed compiler warnings etc
91  *
92  *    Revision 1.3  2001/07/29 19:01:11  jongfoster
93  *    Changed _FILENAME_H to FILENAME_H_INCLUDED.
94  *    Added forward declarations for needed structures.
95  *
96  *    Revision 1.2  2001/06/07 23:06:09  jongfoster
97  *    The host parameter to connect_to() is now const.
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 #include "project.h"
107
108 #ifdef __cplusplus
109 extern "C" {
110 #endif
111
112 struct client_state;
113
114 extern jb_socket connect_to(const char *host, int portnum, struct client_state *csp);
115 #ifdef AMIGA
116 extern int write_socket(jb_socket fd, const char *buf, ssize_t n);
117 #else
118 extern int write_socket(jb_socket fd, const char *buf, size_t n);
119 #endif
120 extern int read_socket(jb_socket fd, char *buf, int n);
121 extern int data_is_available(jb_socket fd, int seconds_to_wait);
122 extern void close_socket(jb_socket fd);
123
124 extern int bind_port(const char *hostnam, int portnum, jb_socket *pfd);
125 extern int accept_connection(struct client_state * csp, jb_socket fd);
126 extern void get_host_information(jb_socket afd, char **ip_address, char **hostname);
127
128 extern unsigned long resolve_hostname_to_ip(const char *host);
129
130 /* Revision control strings from this header and associated .c file */
131 extern const char jbsockets_rcs[];
132 extern const char jbsockets_h_rcs[];
133
134 #ifdef __cplusplus
135 } /* extern "C" */
136 #endif
137
138 #endif /* ndef JBSOCKETS_H_INCLUDED */
139
140 /*
141   Local Variables:
142   tab-width: 3
143   end:
144 */