Killing warnings
[privoxy.git] / jbsockets.h
1 #ifndef JBSOCKETS_H_INCLUDED
2 #define JBSOCKETS_H_INCLUDED
3 #define JBSOCKETS_H_VERSION "$Id: jbsockets.h,v 1.5 2002/03/09 20:03:52 jongfoster 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  *                IJBSWA team.  http://ijbswa.sourceforge.net
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.5  2002/03/09 20:03:52  jongfoster
41  *    - Making various functions return int rather than size_t.
42  *      (Undoing a recent change).  Since size_t is unsigned on
43  *      Windows, functions like read_socket that return -1 on
44  *      error cannot return a size_t.
45  *
46  *      THIS WAS A MAJOR BUG - it caused frequent, unpredictable
47  *      crashes, and also frequently caused JB to jump to 100%
48  *      CPU and stay there.  (Because it thought it had just
49  *      read ((unsigned)-1) == 4Gb of data...)
50  *
51  *    - The signature of write_socket has changed, it now simply
52  *      returns success=0/failure=nonzero.
53  *
54  *    - Trying to get rid of a few warnings --with-debug on
55  *      Windows, I've introduced a new type "jb_socket".  This is
56  *      used for the socket file descriptors.  On Windows, this
57  *      is SOCKET (a typedef for unsigned).  Everywhere else, it's
58  *      an int.  The error value can't be -1 any more, so it's
59  *      now JB_INVALID_SOCKET (which is -1 on UNIX, and in
60  *      Windows it maps to the #define INVALID_SOCKET.)
61  *
62  *    - The signature of bind_port has changed.
63  *
64  *    Revision 1.4  2002/03/07 03:51:36  oes
65  *     - Improved handling of failed DNS lookups
66  *     - Fixed compiler warnings etc
67  *
68  *    Revision 1.3  2001/07/29 19:01:11  jongfoster
69  *    Changed _FILENAME_H to FILENAME_H_INCLUDED.
70  *    Added forward declarations for needed structures.
71  *
72  *    Revision 1.2  2001/06/07 23:06:09  jongfoster
73  *    The host parameter to connect_to() is now const.
74  *
75  *    Revision 1.1.1.1  2001/05/15 13:58:54  oes
76  *    Initial import of version 2.9.3 source tree
77  *
78  *
79  *********************************************************************/
80 \f
81
82 #include "project.h"
83
84 #ifdef __cplusplus
85 extern "C" {
86 #endif
87
88 struct client_state;
89
90 extern jb_socket connect_to(const char *host, int portnum, struct client_state *csp);
91 extern int write_socket(jb_socket fd, const char *buf, size_t n);
92 extern int read_socket(jb_socket fd, char *buf, int n);
93 extern void close_socket(jb_socket fd);
94
95 extern int bind_port(const char *hostnam, int portnum, jb_socket *pfd);
96 extern int accept_connection(struct client_state * csp, jb_socket fd);
97
98 extern unsigned long resolve_hostname_to_ip(const char *host);
99
100 /* Revision control strings from this header and associated .c file */
101 extern const char jbsockets_rcs[];
102 extern const char jbsockets_h_rcs[];
103
104 #ifdef __cplusplus
105 } /* extern "C" */
106 #endif
107
108 #endif /* ndef JBSOCKETS_H_INCLUDED */
109
110 /*
111   Local Variables:
112   tab-width: 3
113   end:
114 */