KSocks Class Reference

This class provides you with an interface to a SOCKS Proxy server. Access to a SOCKS Proxy. More...

#include <ksocks.h>

List of all members.

Public Member Functions

void disableSocks ()

Disable the use of SOCKS immediately.

void enableSocks ()

Enable the use of SOCKS immediately if hasSocks() is true.

bool usingSocks ()

Checks whether SOCKS is currently being used.

bool hasSocks ()

Checks whether SOCKS is available for use.

bool hasWorkingAsyncConnect ()

Returns whether asynchronous connects work with the selected SOCKS impementation.

int connect (int sockfd, const sockaddr *serv_addr, ksocklen_t addrlen)

This is the re-implementation of libc's function of the same name.

signed long int read (int fd, void *buf, unsigned long int count)

This is the re-implementation of libc's function of the same name.

signed long int write (int fd, const void *buf, unsigned long int count)

This is the re-implementation of libc's function of the same name.

int recvfrom (int s, void *buf, unsigned long int len, int flags, sockaddr *from, ksocklen_t *fromlen)

This is the re-implementation of libc's function of the same name.

int sendto (int s, const void *msg, unsigned long int len, int flags, const sockaddr *to, ksocklen_t tolen)

This is the re-implementation of libc's function of the same name.

int recv (int s, void *buf, unsigned long int len, int flags)

This is the re-implementation of libc's function of the same name.

int send (int s, const void *msg, unsigned long int len, int flags)

This is the re-implementation of libc's function of the same name.

int getsockname (int s, sockaddr *name, ksocklen_t *namelen)

This is the re-implementation of libc's function of the same name.

int getpeername (int s, sockaddr *name, ksocklen_t *namelen)

This is the re-implementation of libc's function of the same name.

int accept (int s, sockaddr *addr, ksocklen_t *addrlen)

This is the re-implementation of libc's function of the same name.

int select (int n, fd_set *readfds, fd_set *writefds, fd_set *exceptfds, struct timeval *timeout)

This is the re-implementation of libc's function of the same name.

int listen (int s, int backlog)

This is the re-implementation of libc's function of the same name.

int bind (int sockfd, sockaddr *my_addr, ksocklen_t addrlen)

This is the re-implementation of libc's function of the same name.

void die ()

If you're using this, you're probably doing something wrong.

Static Public Member Functions

KSocks * self ()

Return an instance of class KSocks *.

bool activated ()

Checks whether KSocks has been started (ie someone called self()).

void disable ()

Set this before the first call to KSocks::self() and it will fail to initialize SOCKS.

void setConfig (KConfigBase *config)

Set this before the first call to KSocks::self() and it will use config to read its configuration from.

Friends

class KStaticDeleter< KSocks >

Detailed Description

This class provides you with an interface to a SOCKS Proxy server. Access to a SOCKS Proxy.

A SOCKS server is able to provide full internet access behind a firewall. KSocks is a singleton; there can only be one instance at any given time. To obtain a reference to that instance, use self().

Definition at line 44 of file ksocks.h.

Member Function Documentation

KSocks * KSocks::self ( ) [static]

Return an instance of class KSocks *.
You cannot delete this object. It is a singleton class.
Returns:
the KSock instance

Definition at line 203 of file ksocks.cpp.
Referenced by KExtendedSocket::accept(), KExtendedSocket::connect(), KExtendedSocket::flush(), KSocket::KSocket(), KExtendedSocket::listen(), KExtendedSocket::localAddress(), KExtendedSocket::peerAddress(), KExtendedSocket::readBlock(), KExtendedSocket::waitForMore(), and KExtendedSocket::writeBlock().

bool KSocks::activated ( ) [static]

Checks whether KSocks has been started (ie someone called self()).

Returns:
true if activated

Definition at line 230 of file ksocks.cpp.

void KSocks::disableSocks ( )

Disable the use of SOCKS immediately.

Definition at line 443 of file ksocks.cpp.

void KSocks::enableSocks ( )

Enable the use of SOCKS immediately if hasSocks() is true.

Definition at line 448 of file ksocks.cpp.

bool KSocks::usingSocks ( )

Checks whether SOCKS is currently being used.

Returns:
true if SOCKS is currently being used.

Definition at line 433 of file ksocks.cpp.

bool KSocks::hasSocks ( )

Checks whether SOCKS is available for use.

Returns:
true if SOCKS is available for use.

Definition at line 438 of file ksocks.cpp.

bool KSocks::hasWorkingAsyncConnect ( )

Returns whether asynchronous connects work with the selected SOCKS impementation.

Definition at line 453 of file ksocks.cpp.
Referenced by KExtendedSocket::connect().

int KSocks::connect ( int sockfd,

const sockaddr * serv_addr,

ksocklen_t addrlen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 464 of file ksocks.cpp.
Referenced by KExtendedSocket::connect().

signed long int KSocks::read ( int fd,

void * buf,

unsigned long int count

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 472 of file ksocks.cpp.
Referenced by KExtendedSocket::readBlock().

signed long int KSocks::write ( int fd,

const void * buf,

unsigned long int count

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 479 of file ksocks.cpp.
Referenced by KExtendedSocket::flush(), and KExtendedSocket::writeBlock().

int KSocks::recvfrom ( int s,

void * buf,

unsigned long int len,

int flags,

sockaddr * from,

ksocklen_t * fromlen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 486 of file ksocks.cpp.

int KSocks::sendto ( int s,

const void * msg,

unsigned long int len,

int flags,

const sockaddr * to,

ksocklen_t tolen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 499 of file ksocks.cpp.

int KSocks::recv ( int s,

void * buf,

unsigned long int len,

int flags

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 507 of file ksocks.cpp.

int KSocks::send ( int s,

const void * msg,

unsigned long int len,

int flags

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 514 of file ksocks.cpp.

int KSocks::getsockname ( int s,

sockaddr * name,

ksocklen_t * namelen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 521 of file ksocks.cpp.
Referenced by KSocket::KSocket(), and KExtendedSocket::localAddress().

int KSocks::getpeername ( int s,

sockaddr * name,

ksocklen_t * namelen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 533 of file ksocks.cpp.
Referenced by KExtendedSocket::peerAddress().

int KSocks::accept ( int s,

sockaddr * addr,

ksocklen_t * addrlen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 545 of file ksocks.cpp.
Referenced by KExtendedSocket::accept().

int KSocks::select ( int n,

fd_set * readfds,

fd_set * writefds,

fd_set * exceptfds,

struct timeval * timeout

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 557 of file ksocks.cpp.
Referenced by KExtendedSocket::accept(), KExtendedSocket::connect(), and KExtendedSocket::waitForMore().

int KSocks::listen ( int s,

int backlog

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 565 of file ksocks.cpp.
Referenced by KExtendedSocket::listen().

int KSocks::bind ( int sockfd,

sockaddr * my_addr,

ksocklen_t addrlen

)

This is the re-implementation of libc's function of the same name.
Read the appropriate man page.
Definition at line 572 of file ksocks.cpp.
Referenced by KExtendedSocket::connect(), and KExtendedSocket::listen().

void KSocks::die ( )

If you're using this, you're probably doing something wrong.
Please don't use it.
Definition at line 410 of file ksocks.cpp.

void KSocks::disable ( ) [static]

Set this before the first call to KSocks::self() and it will fail to initialize SOCKS.

Definition at line 197 of file ksocks.cpp.

void KSocks::setConfig ( KConfigBase * config ) [static]

Set this before the first call to KSocks::self() and it will use config to read its configuration from.

Definition at line 217 of file ksocks.cpp.

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


Public Member Functions
void	disableSocks ()
	Disable the use of SOCKS immediately.
void	enableSocks ()
	Enable the use of SOCKS immediately if hasSocks() is true.
bool	usingSocks ()
	Checks whether SOCKS is currently being used.
bool	hasSocks ()
	Checks whether SOCKS is available for use.
bool	hasWorkingAsyncConnect ()
	Returns whether asynchronous connects work with the selected SOCKS impementation.
int	connect (int sockfd, const sockaddr *serv_addr, ksocklen_t addrlen)
	This is the re-implementation of libc's function of the same name.
signed long int	read (int fd, void *buf, unsigned long int count)
	This is the re-implementation of libc's function of the same name.
signed long int	write (int fd, const void *buf, unsigned long int count)
	This is the re-implementation of libc's function of the same name.
int	recvfrom (int s, void buf, unsigned long int len, int flags, sockaddr from, ksocklen_t *fromlen)
	This is the re-implementation of libc's function of the same name.
int	sendto (int s, const void msg, unsigned long int len, int flags, const sockaddr to, ksocklen_t tolen)
	This is the re-implementation of libc's function of the same name.
int	recv (int s, void *buf, unsigned long int len, int flags)
	This is the re-implementation of libc's function of the same name.
int	send (int s, const void *msg, unsigned long int len, int flags)
	This is the re-implementation of libc's function of the same name.
int	getsockname (int s, sockaddr name, ksocklen_t namelen)
	This is the re-implementation of libc's function of the same name.
int	getpeername (int s, sockaddr name, ksocklen_t namelen)
	This is the re-implementation of libc's function of the same name.
int	accept (int s, sockaddr addr, ksocklen_t addrlen)
	This is the re-implementation of libc's function of the same name.
int	select (int n, fd_set readfds, fd_set writefds, fd_set exceptfds, struct timeval timeout)
	This is the re-implementation of libc's function of the same name.
int	listen (int s, int backlog)
	This is the re-implementation of libc's function of the same name.
int	bind (int sockfd, sockaddr *my_addr, ksocklen_t addrlen)
	This is the re-implementation of libc's function of the same name.
void	die ()
	If you're using this, you're probably doing something wrong.
Static Public Member Functions
KSocks *	self ()
	Return an instance of class KSocks *.
bool	activated ()
	Checks whether KSocks has been started (ie someone called self()).
void	disable ()
	Set this before the first call to KSocks::self() and it will fail to initialize SOCKS.
void	setConfig (KConfigBase *config)
	Set this before the first call to KSocks::self() and it will use `config` to read its configuration from.
Friends
class	KStaticDeleter< KSocks >

kdecore Library API Documentation

KSocks Class Reference

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation