.TH "KNetwork::KSocksSocketDevice" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNetwork::KSocksSocketDevice \- The low-level class for SOCKS proxying.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ksockssocketdevice.h>\fP
.PP
Inherits \fBKNetwork::KSocketDevice\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKSocksSocketDevice\fP (const \fBKSocketBase\fP *=0L)"
.br
.ti -1c
.RI "\fBKSocksSocketDevice\fP (int fd)"
.br
.ti -1c
.RI "virtual \fB~KSocksSocketDevice\fP ()"
.br
.ti -1c
.RI "virtual int \fBcapabilities\fP () const "
.br
.ti -1c
.RI "virtual bool \fBbind\fP (const \fBKResolverEntry\fP &address)"
.br
.ti -1c
.RI "virtual bool \fBlisten\fP (int backlog)"
.br
.ti -1c
.RI "virtual bool \fBconnect\fP (const \fBKResolverEntry\fP &address)"
.br
.ti -1c
.RI "virtual \fBKSocksSocketDevice\fP * \fBaccept\fP ()"
.br
.ti -1c
.RI "virtual Q_LONG \fBreadBlock\fP (char *data, Q_ULONG maxlen)"
.br
.ti -1c
.RI "virtual Q_LONG \fBreadBlock\fP (char *data, Q_ULONG maxlen, \fBKSocketAddress\fP &from)"
.br
.ti -1c
.RI "virtual Q_LONG \fBpeekBlock\fP (char *data, Q_ULONG maxlen)"
.br
.ti -1c
.RI "virtual Q_LONG \fBpeekBlock\fP (char *data, Q_ULONG maxlen, \fBKSocketAddress\fP &from)"
.br
.ti -1c
.RI "virtual Q_LONG \fBwriteBlock\fP (const char *data, Q_ULONG len)"
.br
.ti -1c
.RI "virtual Q_LONG \fBwriteBlock\fP (const char *data, Q_ULONG len, const \fBKSocketAddress\fP &to)"
.br
.ti -1c
.RI "virtual \fBKSocketAddress\fP \fBlocalAddress\fP () const "
.br
.ti -1c
.RI "virtual \fBKSocketAddress\fP \fBpeerAddress\fP () const "
.br
.ti -1c
.RI "virtual \fBKSocketAddress\fP \fBexternalAddress\fP () const "
.br
.ti -1c
.RI "virtual bool \fBpoll\fP (bool *input, bool *output, bool *exception=0L, int timeout=-1, bool *timedout=0L)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKSocketDevice\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The low-level class for SOCKS proxying. 

This class reimplements several functions from \fBKSocketDevice\fP in order to implement SOCKS support.
.PP
This works by using KSocks.
.PP
\fBAuthor:\fP
.RS 4
Thiago Macieira <thiago.macieira@kdemail.net>
.RE
.PP
\fBWarning:\fP
.RS 4
This code is untested! 
.RE
.PP

.PP
Definition at line 40 of file ksockssocketdevice.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KSocksSocketDevice::KSocksSocketDevice (const \fBKSocketBase\fP * = \fC0L\fP)"
.PP
Constructor. 
.PP
Definition at line 41 of file ksockssocketdevice.cpp.
.PP
Referenced by accept().
.SS "KSocksSocketDevice::KSocksSocketDevice (int fd)\fC [explicit]\fP"
.PP
Construct from a file descriptor. 
.PP
Definition at line 48 of file ksockssocketdevice.cpp.
.SS "KSocksSocketDevice::~\fBKSocksSocketDevice\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 55 of file ksockssocketdevice.cpp.
.SH "Member Function Documentation"
.PP 
.SS "int KSocksSocketDevice::capabilities () const\fC [virtual]\fP"
.PP
Sets our capabilities. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 60 of file ksockssocketdevice.cpp.
.SS "bool KSocksSocketDevice::bind (const \fBKResolverEntry\fP & address)\fC [virtual]\fP"
.PP
Overrides binding. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 68 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KSocketDevice::create(), KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().
.SS "bool KSocksSocketDevice::listen (int backlog)\fC [virtual]\fP"
.PP
Overrides listening. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 92 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().
.SS "bool KSocksSocketDevice::connect (const \fBKResolverEntry\fP & address)\fC [virtual]\fP"
.PP
Overrides connection. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 114 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KSocketBase::blocking(), KNetwork::KSocketDevice::create(), KNetwork::KActiveSocketBase::resetError(), KNetwork::KSocketBase::setBlocking(), and KNetwork::KActiveSocketBase::setError().
.SS "\fBKSocksSocketDevice\fP * KSocksSocketDevice::accept ()\fC [virtual]\fP"
.PP
Overrides accepting. 
.PP
The return type is specialised. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 164 of file ksockssocketdevice.cpp.
.PP
References KSocksSocketDevice(), and KNetwork::KActiveSocketBase::setError().
.SS "Q_LONG KSocksSocketDevice::readBlock (char * data, Q_ULONG maxlen)\fC [virtual]\fP"
.PP
Overrides reading. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 212 of file ksockssocketdevice.cpp.
.SS "Q_LONG KSocksSocketDevice::readBlock (char * data, Q_ULONG maxlen, \fBKSocketAddress\fP & from)\fC [virtual]\fP"
.PP
Reads data and the source address from this socket. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 233 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().
.SS "Q_LONG KSocksSocketDevice::peekBlock (char * data, Q_ULONG maxlen)\fC [virtual]\fP"
.PP
Overrides peeking. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 254 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().
.SS "Q_LONG KSocksSocketDevice::peekBlock (char * data, Q_ULONG maxlen, \fBKSocketAddress\fP & from)\fC [virtual]\fP"
.PP
Peeks the data in the socket and the source address. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 275 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().
.SS "Q_LONG KSocksSocketDevice::writeBlock (const char * data, Q_ULONG len)\fC [virtual]\fP"
.PP
Overrides writing. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 296 of file ksockssocketdevice.cpp.
.SS "Q_LONG KSocksSocketDevice::writeBlock (const char * data, Q_ULONG len, const \fBKSocketAddress\fP & to)\fC [virtual]\fP"
.PP
Writes the given data to the given destination address. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 301 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().
.SS "\fBKSocketAddress\fP KSocksSocketDevice::localAddress () const\fC [virtual]\fP"
.PP
Overrides getting socket address. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 323 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KSocketAddress::address(), KNetwork::KSocketAddress::length(), localAddress(), and KNetwork::KSocketAddress::setLength().
.PP
Referenced by localAddress().
.SS "\fBKSocketAddress\fP KSocksSocketDevice::peerAddress () const\fC [virtual]\fP"
.PP
Overrides getting peer address. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 352 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KSocketAddress::address(), KNetwork::KSocketAddress::length(), peerAddress(), and KNetwork::KSocketAddress::setLength().
.PP
Referenced by peerAddress().
.SS "\fBKSocketAddress\fP KSocksSocketDevice::externalAddress () const\fC [virtual]\fP"
.PP
Overrides getting external address. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 381 of file ksockssocketdevice.cpp.
.SS "bool KSocksSocketDevice::poll (bool * input, bool * output, bool * exception = \fC0L\fP, int timeout = \fC-1\fP, bool * timedout = \fC0L\fP)\fC [virtual]\fP"
.PP
Overrides polling. 
.PP
Reimplemented from \fBKNetwork::KSocketDevice\fP.
.PP
Definition at line 387 of file ksockssocketdevice.cpp.
.PP
References KNetwork::KActiveSocketBase::resetError(), and KNetwork::KActiveSocketBase::setError().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
