include/wvtcp.h

   1 /* -*- Mode: C++ -*-
   2  * Worldvisions Weaver Software:
   3  *   Copyright (C) 1997-2002 Net Integration Technologies, Inc.
   4  *
   5  * WvStream-based TCP connection and server classes.
   6  */
   7 #ifndef __WVTCP_H
   8 #define __WVTCP_H
   9
  10 #include "wvautoconf.h"
  11 #include <stdio.h>
  12 #if HAVE_SYS_TYPES_H
  13 # include <sys/types.h>
  14 #endif
  15 #if STDC_HEADERS
  16 # include <stdlib.h>
  17 # include <stddef.h>
  18 #else
  19 # if HAVE_STDLIB_H
  20 #  include <stdlib.h>
  21 # endif
  22 #endif
  23 #if HAVE_SYS_SOCKET_H
  24 # include <sys/socket.h>
  25 #endif
  26
  27 #include "wvfdstream.h"
  28 #include "wvaddr.h"
  29 #include "wvresolver.h"
  30
  31
  32 class WvTCPListener;
  33
  34 /**
  35  * WvTCPConn tries to make all outgoing connections asynchronously (in
  36  * the background).  You can tell the connection has been established
  37  * when a select() call returns 'true' with writable==true.
  38  */
  39 class WvTCPConn : public WvFDStream
  40 {
  41     friend class WvTCPListener;
  42 protected:
  43     bool resolved, connected;
  44     WvString hostname;
  45     bool incoming;
  46     WvIPPortAddr remaddr;
  47     WvResolver dns;
  48
  49     /** Start a WvTCPConn on an already-open socket (used by WvTCPListener) */
  50     WvTCPConn(int _fd, const WvIPPortAddr &_remaddr);
  51
  52     /** Connect to the remote end - note the "Protected" above ;) */
  53     void do_connect();
  54
  55     /** Resolve the remote address, if it was fed in non-IP form */
  56     void check_resolver();
  57
  58 public:
  59    /**
  60     * WvTCPConn tries to make all outgoing connections asynchronously (in
  61     * the background).  You can tell the connection has been established
  62     * when a select() call returns 'true' with writable==true.
  63     */
  64     WvTCPConn(const WvIPPortAddr &_remaddr);
  65
  66     /** Resolve the hostname, then connect a new socket */
  67     WvTCPConn(WvStringParm _hostname, uint16_t _port = 0);
  68
  69     /**
  70      * Destructor - rarely do you need to call this - close()
  71      * is a much better way to tear down a TCP Stream ;)
  72      */
  73     virtual ~WvTCPConn();
  74
  75     /**
  76      * function to set up a TCP socket the way we like
  77      * (Read/Write, Non-Blocking, KeepAlive)
  78      */
  79     void nice_tcpopts();
  80
  81     /**
  82      * function to set up a TCP socket the way we like
  83      * In addition to the nice_tcpopts(), set TCP_NODELAY
  84      */
  85     void low_delay();
  86
  87     /**
  88      * function to set up a TCP socket the way we *don't* like: turn the
  89      * timeouts way down so that network errors show up easily for debugging
  90      */
  91     void debug_mode();
  92
  93     /**
  94      * the local address of this socket (ie. from getsockname())
  95      * really useful only for transparent proxies, but always available.
  96      * may be 0.0.0.0 if we did not bind explicitly!
  97      */
  98     WvIPPortAddr localaddr();
  99
 100     /**
 101      * return the remote address (source of all incoming packets),
 102      * which is a constant for any given TCP connection.
 103      */
 104     virtual const WvIPPortAddr *src() const;
 105
 106     /** has the connection been completed yet? */
 107     bool isconnected() const
 108         { return connected; }
 109
 110     /** override pre_select() to cause select() results when resolving names. */
 111     virtual void pre_select(SelectInfo &si);
 112
 113     /**
 114      * override post_select() to set the 'connected' variable as soon as we
 115      * are connected.
 116      */
 117     virtual bool post_select(SelectInfo &si);
 118
 119     /**
 120      * Is this connection OK?
 121      * Note: isok() will always be true if !resolved, even though fd==-1.
 122      */
 123     virtual bool isok() const;
 124
 125 protected:
 126     virtual size_t uwrite(const void *buf, size_t count);
 127
 128 public:
 129     const char *wstype() const { return "WvTCPConn"; }
 130 };
 131
 132
 133 #endif // __WVTCP_H