• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • KNetwork
  • KSocksSocketDevice
Public Member Functions | List of all members
KNetwork::KSocksSocketDevice Class Reference

#include <k3sockssocketdevice.h>

Inheritance diagram for KNetwork::KSocksSocketDevice:
Inheritance graph
[legend]

Public Member Functions

 KSocksSocketDevice (const KSocketBase *=0L)
 
 KSocksSocketDevice (int fd)
 
virtual ~KSocksSocketDevice ()
 
virtual KSocksSocketDevice * accept ()
 
virtual bool bind (const KResolverEntry &address)
 
virtual int capabilities () const
 
virtual bool connect (const KResolverEntry &address)
 
virtual KSocketAddress externalAddress () const
 
virtual bool listen (int backlog)
 
virtual KSocketAddress localAddress () const
 
virtual qint64 peekBlock (char *data, quint64 maxlen)
 
virtual qint64 peekBlock (char *data, quint64 maxlen, KSocketAddress &from)
 
virtual KSocketAddress peerAddress () const
 
virtual bool poll (bool *input, bool *output, bool *exception=0L, int timeout=-1, bool *timedout=0L)
 
virtual qint64 readBlock (char *data, quint64 maxlen)
 
virtual qint64 readBlock (char *data, quint64 maxlen, KSocketAddress &from)
 
virtual qint64 writeBlock (const char *data, quint64 len)
 
virtual qint64 writeBlock (const char *data, quint64 len, const KSocketAddress &to)
 
- Public Member Functions inherited from KNetwork::KSocketDevice
 KSocketDevice (const KSocketBase *=0L, QObject *objparent=0L)
 
 KSocketDevice (int fd, OpenMode mode=ReadWrite)
 
 KSocketDevice (QObject *parent)
 
virtual ~KSocketDevice ()
 
virtual qint64 bytesAvailable () const
 
virtual void close ()
 
virtual bool connect (const KResolverEntry &address, OpenMode mode=ReadWrite)
 
virtual bool create (int family, int type, int protocol)
 
bool create (const KResolverEntry &address)
 
virtual bool disconnect ()
 
QSocketNotifier * exceptionNotifier () const
 
virtual bool flush ()
 
virtual qint64 peekData (char *data, qint64 maxlen, KSocketAddress *from=0L)
 
bool poll (int timeout=-1, bool *timedout=0L)
 
virtual qint64 readData (char *data, qint64 maxlen, KSocketAddress *from=0L)
 
QSocketNotifier * readNotifier () const
 
virtual bool setSocketOptions (int opts)
 
int socket () const
 
virtual qint64 waitForMore (int msecs, bool *timeout=0L)
 
virtual qint64 writeData (const char *data, qint64 len, const KSocketAddress *to=0L)
 
QSocketNotifier * writeNotifier () const
 
- Public Member Functions inherited from KNetwork::KActiveSocketBase
 KActiveSocketBase (QObject *parent)
 
virtual ~KActiveSocketBase ()
 
virtual bool atEnd () const
 
QString errorString () const
 
virtual bool isSequential () const
 
virtual bool open (OpenMode mode)
 
qint64 peek (char *data, qint64 maxlen)
 
qint64 peek (char *data, qint64 maxlen, KSocketAddress &from)
 
virtual qint64 pos () const
 
qint64 read (char *data, qint64 maxlen)
 
QByteArray read (qint64 len)
 
qint64 read (char *data, qint64 maxlen, KSocketAddress &from)
 
virtual bool seek (qint64)
 
virtual void setSocketDevice (KSocketDevice *device)
 
virtual qint64 size () const
 
void ungetChar (char)
 
qint64 write (const char *data, qint64 len)
 
qint64 write (const QByteArray &data)
 
qint64 write (const char *data, qint64 len, const KSocketAddress &to)
 
- Public Member Functions inherited from KNetwork::KSocketBase
 KSocketBase ()
 
virtual ~KSocketBase ()
 
bool addressReuseable () const
 
bool blocking () const
 
bool broadcast () const
 
SocketError error () const
 
QString errorString () const
 
bool isIPv6Only () const
 
QMutex * mutex () const
 
bool noDelay () const
 
virtual bool setAddressReuseable (bool enable)
 
virtual bool setBlocking (bool enable)
 
virtual bool setBroadcast (bool enable)
 
virtual bool setIPv6Only (bool enable)
 
virtual bool setNoDelay (bool enable)
 
int setRequestedCapabilities (int add, int remove=0)
 
KSocketDevice * socketDevice () const
 
- Public Member Functions inherited from KNetwork::KPassiveSocketBase
 KPassiveSocketBase ()
 
virtual ~KPassiveSocketBase ()
 

Additional Inherited Members

- Public Types inherited from KNetwork::KSocketDevice
enum  Capabilities {
  CanConnectString = 0x01, CanBindString = 0x02, CanNotBind = 0x04, CanNotListen = 0x08,
  CanMulticast = 0x10, CanNotUseDatagrams = 0x20
}
 
- Public Types inherited from KNetwork::KSocketBase
enum  SocketError {
  NoError = 0, LookupFailure, AddressInUse, AlreadyCreated,
  AlreadyBound, AlreadyConnected, NotConnected, NotBound,
  NotCreated, WouldBlock, ConnectionRefused, ConnectionTimedOut,
  InProgress, NetFailure, NotSupported, Timeout,
  UnknownError, RemotelyDisconnected
}
 
enum  SocketOptions {
  Blocking = 0x01, AddressReuseable = 0x02, IPv6Only = 0x04, Keepalive = 0x08,
  Broadcast = 0x10, NoDelay = 0x20
}
 
- Static Public Member Functions inherited from KNetwork::KSocketDevice
static void addNewImpl (KSocketDeviceFactoryBase *factory, int capabilities)
 
static KSocketDevice * createDefault (KSocketBase *parent)
 
static KSocketDevice * createDefault (KSocketBase *parent, int capabilities)
 
static KSocketDeviceFactoryBase * setDefaultImpl (KSocketDeviceFactoryBase *factory)
 
- Static Public Member Functions inherited from KNetwork::KSocketBase
static QString errorString (SocketError code)
 
static bool isFatalError (int code)
 
- Protected Member Functions inherited from KNetwork::KSocketDevice
 KSocketDevice (bool, const KSocketBase *parent=0L)
 
virtual QSocketNotifier * createNotifier (QSocketNotifier::Type type) const
 
- Protected Member Functions inherited from KNetwork::KActiveSocketBase
virtual qint64 readData (char *data, qint64 len)
 
void resetError ()
 
void setError (SocketError error)
 
virtual qint64 writeData (const char *data, qint64 len)
 
- Protected Member Functions inherited from KNetwork::KSocketBase
bool hasDevice () const
 
void resetError ()
 
void setError (SocketError error)
 
virtual int socketOptions () const
 
- Protected Attributes inherited from KNetwork::KSocketDevice
int m_sockfd
 

Detailed Description

The low-level class for SOCKS proxying.

This class reimplements several functions from KSocketDevice in order to implement SOCKS support.

This works by using KSocks.

Author
Thiago Macieira thiag.nosp@m.o@kd.nosp@m.e.org
Warning
This code is untested!
Deprecated:
Use KSocketFactory or KLocalSocket instead

Definition at line 42 of file k3sockssocketdevice.h.

Constructor & Destructor Documentation

KSocksSocketDevice::KSocksSocketDevice ( const KSocketBase *  obj = 0L)

Constructor.

Definition at line 47 of file k3sockssocketdevice.cpp.

KSocksSocketDevice::KSocksSocketDevice ( int  fd)
explicit

Construct from a file descriptor.

Definition at line 54 of file k3sockssocketdevice.cpp.

KSocksSocketDevice::~KSocksSocketDevice ( )
virtual

Destructor.

Definition at line 61 of file k3sockssocketdevice.cpp.

Member Function Documentation

KSocksSocketDevice * KSocksSocketDevice::accept ( )
virtual

Overrides accepting.

The return type is specialized.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 168 of file k3sockssocketdevice.cpp.

bool KSocksSocketDevice::bind ( const KResolverEntry &  address)
virtual

Overrides binding.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 74 of file k3sockssocketdevice.cpp.

int KSocksSocketDevice::capabilities ( ) const
virtual

Sets our capabilities.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 66 of file k3sockssocketdevice.cpp.

bool KSocksSocketDevice::connect ( const KResolverEntry &  address)
virtual

Overrides connection.

Definition at line 119 of file k3sockssocketdevice.cpp.

KSocketAddress KSocksSocketDevice::externalAddress ( ) const
virtual

Overrides getting external address.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 385 of file k3sockssocketdevice.cpp.

bool KSocksSocketDevice::listen ( int  backlog)
virtual

Overrides listening.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 98 of file k3sockssocketdevice.cpp.

KSocketAddress KSocksSocketDevice::localAddress ( ) const
virtual

Overrides getting socket address.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 327 of file k3sockssocketdevice.cpp.

qint64 KSocksSocketDevice::peekBlock ( char *  data,
quint64  maxlen 
)
virtual

Overrides peeking.

Definition at line 258 of file k3sockssocketdevice.cpp.

qint64 KSocksSocketDevice::peekBlock ( char *  data,
quint64  maxlen,
KSocketAddress &  from 
)
virtual

Overrides peeking.

Definition at line 279 of file k3sockssocketdevice.cpp.

KSocketAddress KSocksSocketDevice::peerAddress ( ) const
virtual

Overrides getting peer address.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 356 of file k3sockssocketdevice.cpp.

bool KSocksSocketDevice::poll ( bool *  input,
bool *  output,
bool *  exception = 0L,
int  timeout = -1,
bool *  timedout = 0L 
)
virtual

Overrides polling.

Reimplemented from KNetwork::KSocketDevice.

Definition at line 391 of file k3sockssocketdevice.cpp.

qint64 KSocksSocketDevice::readBlock ( char *  data,
quint64  maxlen 
)
virtual

Overrides reading.

Definition at line 216 of file k3sockssocketdevice.cpp.

qint64 KSocksSocketDevice::readBlock ( char *  data,
quint64  maxlen,
KSocketAddress &  from 
)
virtual

Overrides reading.

Todo:
(Thiago, you saw this coming) Actually document this. What is the from for?

Definition at line 237 of file k3sockssocketdevice.cpp.

qint64 KSocksSocketDevice::writeBlock ( const char *  data,
quint64  len 
)
virtual

Overrides writing.

Definition at line 300 of file k3sockssocketdevice.cpp.

qint64 KSocksSocketDevice::writeBlock ( const char *  data,
quint64  len,
const KSocketAddress &  to 
)
virtual

Overrides writing.

Definition at line 305 of file k3sockssocketdevice.cpp.


The documentation for this class was generated from the following files:
  • k3sockssocketdevice.h
  • k3sockssocketdevice.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:47:12 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal