jbsockets.h

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