KNetwork::KHttpProxySocketDevice Class Reference

#include <khttproxysocketdevice.h>

Inheritance diagram for KNetwork::KHttpProxySocketDevice:

Public Member Functions
	KHttpProxySocketDevice (const TDESocketBase *=0L)
	KHttpProxySocketDevice (const KResolverEntry &proxy)
virtual	~KHttpProxySocketDevice ()
virtual int	capabilities () const
const KResolverEntry &	proxyServer () const
void	setProxyServer (const KResolverEntry &proxy)
virtual void	close ()
virtual bool	connect (const KResolverEntry &address)
virtual bool	connect (const TQString &name, const TQString &service)
virtual TDESocketAddress	peerAddress () const
virtual TDESocketAddress	externalAddress () const
Public Member Functions inherited from KNetwork::TDESocketDevice
	TDESocketDevice (const TDESocketBase *=0L)
	TDESocketDevice (int fd)
virtual	~TDESocketDevice ()
int	socket () const
virtual int	capabilities () const
virtual bool	setSocketOptions (int opts)
virtual bool	open (int mode)
virtual void	close ()
virtual void	flush ()
virtual bool	create (int family, int type, int protocol)
bool	create (const KResolverEntry &address)
virtual bool	bind (const KResolverEntry &address)
virtual bool	listen (int backlog=5)
virtual bool	connect (const KResolverEntry &address)
virtual TDESocketDevice *	accept ()
virtual bool	disconnect ()
virtual TQ_LONG	bytesAvailable () const
virtual TQ_LONG	waitForMore (int msecs, bool *timeout=0L)
virtual TQ_LONG	readBlock (char *data, TQ_ULONG maxlen)
virtual TQ_LONG	readBlock (char *data, TQ_ULONG maxlen, TDESocketAddress &from)
virtual TQ_LONG	peekBlock (char *data, TQ_ULONG maxlen)
virtual TQ_LONG	peekBlock (char *data, TQ_ULONG maxlen, TDESocketAddress &from)
virtual TQ_LONG	writeBlock (const char *data, TQ_ULONG len)
virtual TQ_LONG	writeBlock (const char *data, TQ_ULONG len, const TDESocketAddress &to)
virtual TDESocketAddress	localAddress () const
virtual TDESocketAddress	peerAddress () const
virtual TDESocketAddress	externalAddress () const
TQSocketNotifier *	readNotifier () const
TQSocketNotifier *	writeNotifier () const
TQSocketNotifier *	exceptionNotifier () const
virtual bool	poll (bool *input, bool *output, bool *exception=0L, int timeout=-1, bool *timedout=0L)
bool	poll (int timeout=-1, bool *timedout=0L)
Public Member Functions inherited from KNetwork::KActiveSocketBase
	KActiveSocketBase ()
virtual	~KActiveSocketBase ()
virtual bool	bind (const KResolverEntry &address)=0
virtual bool	connect (const KResolverEntry &address)=0
virtual bool	disconnect ()=0
virtual Offset	size () const
virtual Offset	at () const
virtual bool	at (Offset)
virtual bool	atEnd () const
virtual TQ_LONG	bytesAvailable () const =0
virtual TQ_LONG	waitForMore (int msecs, bool *timeout=0L)=0
virtual TQ_LONG	readBlock (char *data, TQ_ULONG len)=0
virtual TQ_LONG	readBlock (char *data, TQ_ULONG maxlen, TDESocketAddress &from)=0
virtual TQ_LONG	peekBlock (char *data, TQ_ULONG maxlen)=0
virtual TQ_LONG	peekBlock (char *data, TQ_ULONG maxlen, TDESocketAddress &from)=0
virtual TQ_LONG	writeBlock (const char *data, TQ_ULONG len)=0
virtual TQ_LONG	writeBlock (const char *data, TQ_ULONG len, const TDESocketAddress &to)=0
virtual int	getch ()
virtual int	putch (int ch)
virtual int	ungetch (int)
virtual TDESocketAddress	localAddress () const =0
virtual TDESocketAddress	peerAddress () const =0
Public Member Functions inherited from KNetwork::TDESocketBase
	TDESocketBase ()
virtual	~TDESocketBase ()
virtual bool	setBlocking (bool enable)
bool	blocking () const
virtual bool	setAddressReuseable (bool enable)
bool	addressReuseable () const
virtual bool	setIPv6Only (bool enable)
bool	isIPv6Only () const
virtual bool	setBroadcast (bool enable)
bool	broadcast () const
TDESocketDevice *	socketDevice () const
virtual void	setSocketDevice (TDESocketDevice *device)
int	setRequestedCapabilities (int add, int remove=0)
SocketError	error () const
TQString	errorString () const
TQMutex *	mutex () const
Public Member Functions inherited from KNetwork::KPassiveSocketBase
	KPassiveSocketBase ()
virtual	~KPassiveSocketBase ()
virtual bool	bind (const KResolverEntry &address)=0
virtual bool	listen (int backlog)=0
virtual void	close ()=0
virtual KActiveSocketBase *	accept ()=0
virtual TDESocketAddress	localAddress () const =0
virtual TDESocketAddress	externalAddress () const =0

Static Public Attributes
static KResolverEntry	defaultProxy

Additional Inherited Members
Public Types inherited from KNetwork::TDESocketDevice
enum	Capabilities {   CanConnectString = 0x01 , CanBindString = 0x02 , CanNotBind = 0x04 , CanNotListen = 0x08 ,   CanMulticast = 0x10 , CanNotUseDatagrams = 0x20 }
Public Types inherited from KNetwork::TDESocketBase
enum	SocketOptions {   Blocking = 0x01 , AddressReuseable = 0x02 , IPv6Only = 0x04 , Keepalive = 0x08 ,   Broadcast = 0x10 }
enum	SocketError {   NoError = 0 , LookupFailure , AddressInUse , AlreadyCreated ,   AlreadyBound , AlreadyConnected , NotConnected , NotBound ,   NotCreated , WouldBlock , ConnectionRefused , ConnectionTimedOut ,   InProgress , NetFailure , NotSupported , Timeout ,   UnknownError , RemotelyDisconnected }
Static Public Member Functions inherited from KNetwork::TDESocketDevice
static TDESocketDevice *	createDefault (TDESocketBase *parent)
static TDESocketDevice *	createDefault (TDESocketBase *parent, int capabilities)
static TDESocketDeviceFactoryBase *	setDefaultImpl (TDESocketDeviceFactoryBase *factory)
static void	addNewImpl (TDESocketDeviceFactoryBase *factory, int capabilities)
Static Public Member Functions inherited from KNetwork::TDESocketBase
static TQString	errorString (SocketError code)
static bool	isFatalError (int code)
Protected Member Functions inherited from KNetwork::TDESocketDevice
	TDESocketDevice (bool, const TDESocketBase *parent=0L)
virtual TQSocketNotifier *	createNotifier (TQSocketNotifier::Type type) const
Protected Member Functions inherited from KNetwork::KActiveSocketBase
void	setError (int status, SocketError error)
void	resetError ()
Protected Member Functions inherited from KNetwork::TDESocketBase
virtual bool	setSocketOptions (int opts)
virtual int	socketOptions () const
bool	hasDevice () const
void	setError (SocketError error)
Protected Attributes inherited from KNetwork::TDESocketDevice
int	m_sockfd

Detailed Description

The low-level backend for HTTP proxying.

This class derives from TDESocketDevice and implements the necessary calls to make a connection through an HTTP proxy.

Author

Thiago Macieira thiag.nosp@m.o.ma.nosp@m.cieir.nosp@m.a@kd.nosp@m.email.nosp@m..net

Definition at line 43 of file khttpproxysocketdevice.h.

Constructor & Destructor Documentation

KHttpProxySocketDevice() [1/2]

KHttpProxySocketDevice::KHttpProxySocketDevice

(

const TDESocketBase *

parent = 0L

)

Constructor.

Definition at line 55 of file khttpproxysocketdevice.cpp.

KHttpProxySocketDevice() [2/2]

KHttpProxySocketDevice::KHttpProxySocketDevice

(

const KResolverEntry &

proxy

)

Constructor with proxy server's address.

Definition at line 60 of file khttpproxysocketdevice.cpp.

~KHttpProxySocketDevice()

KHttpProxySocketDevice::~KHttpProxySocketDevice ( )

virtual

Destructor.

Definition at line 66 of file khttpproxysocketdevice.cpp.

Member Function Documentation

capabilities()

int KHttpProxySocketDevice::capabilities ( ) const

virtual

Sets our capabilities.

Reimplemented from KNetwork::TDESocketDevice.

Definition at line 74 of file khttpproxysocketdevice.cpp.

close()

void KHttpProxySocketDevice::close ( )

virtual

Closes the socket.

Reimplemented from KNetwork::TDESocketDevice.

Definition at line 90 of file khttpproxysocketdevice.cpp.

connect() [1/2]

bool KHttpProxySocketDevice::connect ( const KResolverEntry &  address )

virtual

Overrides connection.

Reimplemented from KNetwork::TDESocketDevice.

Definition at line 109 of file khttpproxysocketdevice.cpp.

connect() [2/2]

bool KHttpProxySocketDevice::connect ( const TQString &  name, const TQString &  service  )

virtual

Name-based connection.

We can tell the HTTP proxy server the full name.

Definition at line 131 of file khttpproxysocketdevice.cpp.

externalAddress()

TDESocketAddress KHttpProxySocketDevice::externalAddress ( ) const

virtual

Return the externally visible address.

We can't tell what that address is, so this function always returns an empty object.

Reimplemented from KNetwork::TDESocketDevice.

Definition at line 104 of file khttpproxysocketdevice.cpp.

peerAddress()

TDESocketAddress KHttpProxySocketDevice::peerAddress ( ) const

virtual

Return the peer address.

Reimplemented from KNetwork::TDESocketDevice.

Definition at line 97 of file khttpproxysocketdevice.cpp.

proxyServer()

const KResolverEntry & KHttpProxySocketDevice::proxyServer

(

)

const

Retrieves the proxy server address.

Definition at line 80 of file khttpproxysocketdevice.cpp.

setProxyServer()

void KHttpProxySocketDevice::setProxyServer

(

const KResolverEntry &

proxy

)

Sets the proxy server address.

Definition at line 85 of file khttpproxysocketdevice.cpp.

Member Data Documentation

defaultProxy

KResolverEntry KHttpProxySocketDevice::defaultProxy

static

This is the default proxy server to be used.

Applications may want to set this value so that calling setProxyServer is unnecessary.

Definition at line 117 of file khttpproxysocketdevice.h.

---

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

• khttpproxysocketdevice.h
• khttpproxysocketdevice.cpp