kdecore/network/k3sockssocketdevice.h

   1 /*  -*- C++ -*-
   2  *  Copyright (C) 2004,2005 Thiago Macieira <thiago@kde.org>
   3  *
   4  *  This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU Library General Public
   6  *  License as published by the Free Software Foundation; either
   7  *  version 2 of the License, or (at your option) any later version.
   8  *
   9  *  This library is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  *  Library General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU Library General Public License
  15  *  along with this library; see the file COPYING.LIB.  If not, write to
  16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  *  Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef KSOCKSSOCKETDEVICE_H
  21 #define KSOCKSSOCKETDEVICE_H
  22
  23 #include "k3socketdevice.h"
  24
  25 namespace KNetwork {
  26
  27 class KSocksSocketDevicePrivate;
  28 /**
  29  * @class KSocksSocketDevice k3sockssocketdevice.h k3sockssocketdevice.h
  30  * @brief The low-level class for SOCKS proxying.
  31  *
  32  * This class reimplements several functions from KSocketDevice in order
  33  * to implement SOCKS support.
  34  *
  35  * This works by using KSocks.
  36  *
  37  * @author Thiago Macieira <thiago@kde.org>
  38  *
  39  * @warning This code is untested!
  40  * @deprecated Use KSocketFactory or KLocalSocket instead
  41  */
  42 class KDECORE_EXPORT KSocksSocketDevice: public KSocketDevice
  43 {
  44 public:
  45   /**
  46    * Constructor.
  47    */
  48   KSocksSocketDevice(const KSocketBase* = 0L);
  49
  50   /**
  51    * Construct from a file descriptor.
  52    */
  53   explicit KSocksSocketDevice(int fd);
  54
  55   /**
  56    * Destructor.
  57    */
  58   virtual ~KSocksSocketDevice();
  59
  60   /**
  61    * Sets our capabilities.
  62    */
  63   virtual int capabilities() const;
  64
  65   /**
  66    * Overrides binding.
  67    */
  68   virtual bool bind(const KResolverEntry& address);
  69
  70   /**
  71    * Overrides listening.
  72    */
  73   virtual bool listen(int backlog);
  74
  75   /**
  76    * Overrides connection.
  77    */
  78   virtual bool connect(const KResolverEntry& address);
  79
  80   /**
  81    * Overrides accepting. The return type is specialized.
  82    */
  83   virtual KSocksSocketDevice* accept();
  84
  85   /**
  86    * Overrides reading.
  87    */
  88   virtual qint64 readBlock(char *data, quint64 maxlen);
  89
  90   /**
  91    * Overrides reading.
  92    *
  93    * @todo (Thiago, you saw this coming) Actually document this.
  94    *       What is the @p from for?
  95    */
  96   virtual qint64 readBlock(char *data, quint64 maxlen, KSocketAddress& from);
  97
  98   /**
  99    * Overrides peeking.
 100    */
 101   virtual qint64 peekBlock(char *data, quint64 maxlen);
 102
 103   /**
 104    * Overrides peeking.
 105    */
 106   virtual qint64 peekBlock(char *data, quint64 maxlen, KSocketAddress& from);
 107
 108   /**
 109    * Overrides writing.
 110    */
 111   virtual qint64 writeBlock(const char *data, quint64 len);
 112
 113   /**
 114    * Overrides writing.
 115    */
 116   virtual qint64 writeBlock(const char *data, quint64 len, const KSocketAddress& to);
 117
 118   /**
 119    * Overrides getting socket address.
 120    */
 121   virtual KSocketAddress localAddress() const;
 122
 123   /**
 124    * Overrides getting peer address.
 125    */
 126   virtual KSocketAddress peerAddress() const;
 127
 128   /**
 129    * Overrides getting external address.
 130    */
 131   virtual KSocketAddress externalAddress() const;
 132
 133   /**
 134    * Overrides polling.
 135    */
 136   virtual bool poll(bool* input, bool* output, bool* exception = 0L,
 137                     int timeout = -1, bool* timedout = 0L);
 138
 139 private:
 140   static void initSocks();
 141   friend class KSocketDevice;
 142   KSocksSocketDevicePrivate * const d;
 143 };
 144
 145 }                               // namespace KNetwork
 146
 147 #endif