#include <socks5bytestream.h>

Inheritance diagram for SOCKS5Bytestream:

Collaboration diagram for SOCKS5Bytestream:

Public Member Functions
virtual	~SOCKS5Bytestream ()
bool	isOpen () const
bool	connect ()
void	close ()
bool	send (const std::string &data)
ConnectionError	recv (int timeout=-1)
const std::string &	sid () const
const JID &	target () const
const JID &	initiator () const
void	setConnectionImpl (ConnectionBase *connection)
ConnectionBase *	connectionImpl ()
void	setStreamHosts (const StreamHostList &hosts)
void	registerSOCKS5BytestreamDataHandler (SOCKS5BytestreamDataHandler *s5bdh)
void	removeSOCKS5BytestreamDataHandler ()
virtual void	handleReceivedData (const ConnectionBase *connection, const std::string &data)
virtual void	handleConnect (const ConnectionBase *connection)
virtual void	handleDisconnect (const ConnectionBase *connection, ConnectionError reason)
Public Member Functions inherited from ConnectionDataHandler
virtual	~ConnectionDataHandler ()

Detailed Description

An implementation of a single SOCKS5 Bytestream (XEP-0065).

One instance of this class handles one bytestream.

See SOCKS5BytestreamManager for a detailed description on how to implement SOCKS5 Bytestreams in your application.

Author: Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net

Since: 0.9

Definition at line 44 of file socks5bytestream.h.

Constructor & Destructor Documentation

~SOCKS5Bytestream ( )

virtual

Virtual destructor.

Definition at line 38 of file socks5bytestream.cpp.

Member Function Documentation

void close ( )

Closes the bytestream.

Definition at line 107 of file socks5bytestream.cpp.

bool connect ( )

This function starts the connection process. That is, it attempts to connect to each of the available StreamHosts. Once a working StreamHosts is found, the SOCKS5BytestreamManager is notified and the function returns.

Returns: True if a connection to a StreamHost could be established, false otherwise.

Note: If false is returned you should hand this SOCKS5Bytestream object to SOCKS5BytestreamManager::dispose() for deletion.; Make sure you have a SOCKS5BytestreamDataHandler registered (using registerSOCKS5BytestreamDataHandler()) before calling this function.

Definition at line 61 of file socks5bytestream.cpp.

ConnectionBase* connectionImpl ( )

inline

This function returns the concrete connection implementation currently in use.

Returns: The concrete connection implementation.

Since: 0.9.7

Definition at line 129 of file socks5bytestream.h.

void handleConnect ( const ConnectionBase * connection )

virtual

This function is called when e.g. the raw TCP connection was established.

Parameters

connection The connection.

Implements ConnectionDataHandler.

Definition at line 140 of file socks5bytestream.cpp.

void handleDisconnect	(	const ConnectionBase *	connection,
		ConnectionError	reason
	)

virtual

This connection is called when e.g. the raw TCP connection was closed.

Parameters

connection	The connection.
reason	The reason for the disconnect.

Implements ConnectionDataHandler.

Definition at line 145 of file socks5bytestream.cpp.

void handleReceivedData	(	const ConnectionBase *	connection,
		const std::string &	data
	)

virtual

This function is called for received from the underlying transport.

Parameters

connection	The connection that received the data.
data	The data received.

Implements ConnectionDataHandler.

Definition at line 117 of file socks5bytestream.cpp.

const JID& initiator ( ) const

inline

Returns the initiating entity's JID. If this bytestream is remote-initiated, this is the remote entity's JID. If it is local-initiated, this is the local JID.

Returns: The initiator's JID.

Definition at line 115 of file socks5bytestream.h.

bool isOpen ( ) const

inline

Returns whether the bytestream is open, that is, accepted by both parties.

Returns: Whether the bytestream is open or not.

Definition at line 58 of file socks5bytestream.h.

ConnectionError recv ( int timeout = -1 )

Call this function repeatedly to receive data from the socket. You should even do this if you use the bytestream to merely send data.

Parameters

timeout The timeout to use for select in microseconds. Default of -1 means blocking.

Returns: The state of the connection.

Definition at line 92 of file socks5bytestream.cpp.

void registerSOCKS5BytestreamDataHandler ( SOCKS5BytestreamDataHandler * s5bdh )

inline

Use this function to register an object that will receive any notifications from the SOCKS5Bytestream instance. Only one SOCKS5BytestreamDataHandler can be registered at any one time.

Parameters

s5bdh The SOCKS5BytestreamDataHandler-derived object to receive notifications.

Definition at line 143 of file socks5bytestream.h.

void removeSOCKS5BytestreamDataHandler ( )

inline

Removes the registered SOCKS5BytestreamDataHandler.

Definition at line 149 of file socks5bytestream.h.

bool send ( const std::string & data )

Use this function to send a chunk of data over an open bytestream. There is no limit for the size of the chunk (other than your machine's memory). If the stream is not open or has been closed again (by the remote entity or locally), nothing is sent and false is returned.

Parameters

data	The block of data to send.

Returns: True if the data has been sent (no guarantee of receipt), false in case of an error.

Definition at line 84 of file socks5bytestream.cpp.

void setConnectionImpl ( ConnectionBase * connection )

Sets the connection to use.

Parameters

connection The connection. The bytestream will own the connection, any previously set connection gets deleted.

Definition at line 47 of file socks5bytestream.cpp.

void setStreamHosts ( const StreamHostList & hosts )

inline

Use this function to set the available StreamHosts. Usually you should not need to use this function directly.

Definition at line 135 of file socks5bytestream.h.

const std::string& sid ( ) const

inline

Lets you retrieve the stream's ID.

Returns: The stream's ID.

Definition at line 101 of file socks5bytestream.h.

const JID& target ( ) const

inline

Returns the target entity's JID. If this bytestream is remote-initiated, this is the local JID. If it is local-initiated, this is the remote entity's JID.

Returns: The target's JID.

Definition at line 108 of file socks5bytestream.h.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation