KNetwork::KSocksSocketDevice Class Reference

The low-level class for SOCKS proxying. More...

#include <k3sockssocketdevice.h>

Inheritance diagram for KNetwork::KSocksSocketDevice:

List of all members.

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, KSocketAddress &from)
virtual qint64	readBlock (char *data, quint64 maxlen)
virtual qint64	writeBlock (const char *data, quint64 len)
virtual qint64	writeBlock (const char *data, quint64 len, const KSocketAddress &to)

---

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 <thiago@kde.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,
		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::readBlock	(	char *	data,
		quint64	maxlen
	)		[virtual]

Overrides reading.

Definition at line 216 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.

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

Overrides writing.

Definition at line 300 of file k3sockssocketdevice.cpp.

---

The documentation for this class was generated from the following files:

• k3sockssocketdevice.h
• k3sockssocketdevice.cpp