Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | Related Pages
gloox::SOCKS5Bytestream

SOCKS5Bytestream Class Reference

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

#include <socks5bytestream.h>

Inherits ConnectionDataHandler, and Bytestream.

Inheritance diagram for SOCKS5Bytestream:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~SOCKS5Bytestream ()
virtual bool connect ()
virtual void close ()
virtual bool send (const std::string &data)
virtual ConnectionError recv (int timeout=-1)
void setConnectionImpl (ConnectionBase *connection)
ConnectionBase * connectionImpl ()
void setStreamHosts (const StreamHostList &hosts)
virtual void handleReceivedData (const ConnectionBase *connection, const std::string &data)
virtual void handleConnect (const ConnectionBase *connection)
virtual void handleDisconnect (const ConnectionBase *connection, ConnectionError reason)

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@camaya.net>
Since:
0.9

Definition at line 42 of file socks5bytestream.h.

Constructor & Destructor Documentation

~SOCKS5Bytestream (   )  [virtual]
 

Virtual destructor.

Definition at line 37 of file socks5bytestream.cpp.

Member Function Documentation

void close (   )  [virtual]
 

Closes the bytestream.

Implements Bytestream.

Definition at line 106 of file socks5bytestream.cpp.

bool connect (   )  [virtual]
 

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.

Implements Bytestream.

Definition at line 60 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 101 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 139 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 144 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 116 of file socks5bytestream.cpp.

ConnectionError recv (  int  timeout = -1  )  [virtual]
 

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.

Implements Bytestream.

Definition at line 91 of file socks5bytestream.cpp.

bool send (  const std::string &  data  )  [virtual]
 

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.

Implements Bytestream.

Definition at line 83 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 46 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 107 of file socks5bytestream.h.

The documentation for this class was generated from the following files:
Generated on Tue Apr 22 15:10:15 2008 for gloox by  doxygen 1.4.1