You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdelibs/kdecore/network/ksockssocketdevice.h

130 lines
3.1 KiB

/* -*- C++ -*-
* Copyright (C) 2004 Thiago Macieira <thiago.macieira@kdemail.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KSOCKSSOCKETDEVICE_H
#define KSOCKSSOCKETDEVICE_H
#include "ksocketdevice.h"
namespace KNetwork {
/**
* @class KSocksSocketDevice ksockssocketdevice.h ksockssocketdevice.h
* @brief The low-level class for SOCKS proxying.
*
* This class reimplements several functions from @ref KSocketDevice in order
* to implement SOCKS support.
*
* This works by using KSocks.
*
* @author Thiago Macieira <thiago.macieira@kdemail.net>
*
* @warning This code is untested!
*/
class KDECORE_EXPORT KSocksSocketDevice: public KSocketDevice
{
public:
/**
* Constructor.
*/
KSocksSocketDevice(const KSocketBase* = 0L);
/**
* Construct from a file descriptor.
*/
explicit KSocksSocketDevice(int fd);
/**
* Destructor.
*/
virtual ~KSocksSocketDevice();
/**
* Sets our capabilities.
*/
virtual int capabilities() const;
/**
* Overrides binding.
*/
virtual bool bind(const KResolverEntry& address);
/**
* Overrides listening.
*/
virtual bool listen(int backlog);
/**
* Overrides connection.
*/
virtual bool connect(const KResolverEntry& address);
/**
* Overrides accepting. The return type is specialised.
*/
virtual KSocksSocketDevice* accept();
/**
* Overrides reading.
*/
virtual TQ_LONG readBlock(char *data, TQ_ULONG maxlen);
virtual TQ_LONG readBlock(char *data, TQ_ULONG maxlen, KSocketAddress& from);
/**
* Overrides peeking.
*/
virtual TQ_LONG peekBlock(char *data, TQ_ULONG maxlen);
virtual TQ_LONG peekBlock(char *data, TQ_ULONG maxlen, KSocketAddress& from);
/**
* Overrides writing.
*/
virtual TQ_LONG writeBlock(const char *data, TQ_ULONG len);
virtual TQ_LONG writeBlock(const char *data, TQ_ULONG len, const KSocketAddress& to);
/**
* Overrides getting socket address.
*/
virtual KSocketAddress localAddress() const;
/**
* Overrides getting peer address.
*/
virtual KSocketAddress peerAddress() const;
/**
* Overrides getting external address.
*/
virtual KSocketAddress externalAddress() const;
/**
* Overrides polling.
*/
virtual bool poll(bool* input, bool* output, bool* exception = 0L,
int timeout = -1, bool* timedout = 0L);
private:
static void initSocks();
friend class KSocketDevice;
};
} // namespace KNetwork
#endif