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