KNetwork::KSocksSocketDevice Class Reference

#include <k3sockssocketdevice.h>

Inheritance diagram for KNetwork::KSocksSocketDevice:

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 QIODevice
	QIODevice ()
	QIODevice (QObject *parent)
virtual	~QIODevice ()
void	aboutToClose ()
Offset	at () const
bool	at (Offset offset)
virtual qint64	bytesToWrite () const
void	bytesWritten (qint64 bytes)
virtual bool	canReadLine () const
QString	errorString () const
int	flags () const
int	getch ()
bool	getChar (char *c)
bool	isAsynchronous () const
bool	isBuffered () const
bool	isCombinedAccess () const
bool	isDirectAccess () const
bool	isInactive () const
bool	isOpen () const
bool	isRaw () const
bool	isReadable () const
bool	isSequentialAccess () const
bool	isSynchronous () const
bool	isTextModeEnabled () const
bool	isTranslated () const
bool	isWritable () const
int	mode () const
virtual bool	open (QFlags< QIODevice::OpenModeFlag > mode)
OpenMode	openMode () const
qint64	peek (char *data, qint64 maxSize)
QByteArray	peek (qint64 maxSize)
int	putch (int ch)
bool	putChar (char c)
qint64	read (char *data, qint64 maxSize)
QByteArray	read (qint64 maxSize)
QByteArray	readAll ()
qint64	readBlock (char *data, quint64 size)
void	readChannelFinished ()
QByteArray	readLine (qint64 maxSize)
qint64	readLine (char *data, qint64 maxSize)
void	readyRead ()
virtual bool	reset ()
void	resetStatus ()
void	setTextModeEnabled (bool enabled)
int	state () const
Status	status () const
int	ungetch (int ch)
void	ungetChar (char c)
virtual bool	waitForBytesWritten (int msecs)
virtual bool	waitForReadyRead (int msecs)
qint64	write (const char *data)
qint64	write (const char *data, qint64 maxSize)
qint64	write (const QByteArray &byteArray)
qint64	writeBlock (const QByteArray &data)
qint64	writeBlock (const char *data, quint64 size)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const
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 QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Public Member Functions inherited from KNetwork::KSocketBase
static QString	errorString (SocketError code)
static bool	isFatalError (int code)
Public Attributes inherited from QIODevice
typedef	Offset
typedef	OpenMode
typedef	Status
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 QIODevice
virtual qint64	readData (char *data, qint64 maxSize)=0
virtual qint64	readLineData (char *data, qint64 maxSize)
void	setErrorString (const QString &str)
void	setOpenMode (QFlags< QIODevice::OpenModeFlag > openMode)
virtual qint64	writeData (const char *data, qint64 maxSize)=0
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Protected Member Functions inherited from KNetwork::KSocketBase
bool	hasDevice () const
void	resetError ()
void	setError (SocketError error)
virtual int	socketOptions () const
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Protected Attributes inherited from KNetwork::KSocketDevice
int	m_sockfd
Properties inherited from QObject
	objectName

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