gloox  1.0.1
Public Member Functions | List of all members
SOCKS5Bytestream Class Reference

#include <socks5bytestream.h>

Inheritance diagram for SOCKS5Bytestream:
Inheritance graph

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)
ConnectionBaseconnectionImpl ()
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)
- Public Member Functions inherited from ConnectionDataHandler
virtual ~ConnectionDataHandler ()
- Public Member Functions inherited from Bytestream
 Bytestream (StreamType type, LogSink &logInstance, const JID &initiator, const JID &target, const std::string &sid)
virtual ~Bytestream ()
bool isOpen () const
const std::string & sid () const
StreamType type () const
const JIDtarget () const
const JIDinitiator () const
void registerBytestreamDataHandler (BytestreamDataHandler *bdh)
void removeBytestreamDataHandler ()

Additional Inherited Members

- Public Types inherited from Bytestream
enum  StreamType { S5B, IBB }
- Protected Attributes inherited from Bytestream
const LogSinkm_logInstance
const JID m_initiator
const JID m_target
StreamType m_type
std::string m_sid
bool m_open

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.

Jakob Schroeter

Definition at line 42 of file socks5bytestream.h.

Constructor & Destructor Documentation

~SOCKS5Bytestream ( )

Virtual destructor.

Definition at line 37 of file socks5bytestream.cpp.

Member Function Documentation

void close ( )

Closes the bytestream.

Implements Bytestream.

Definition at line 110 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.

True if a connection to a StreamHost could be established, false otherwise.
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 ( )

This function returns the concrete connection implementation currently in use.

The concrete connection implementation.

Definition at line 101 of file socks5bytestream.h.

void handleConnect ( const ConnectionBase connection)

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

connectionThe connection.

Implements ConnectionDataHandler.

Definition at line 144 of file socks5bytestream.cpp.

void handleDisconnect ( const ConnectionBase connection,
ConnectionError  reason 

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

connectionThe connection.
reasonThe reason for the disconnect.

Implements ConnectionDataHandler.

Definition at line 149 of file socks5bytestream.cpp.

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

This function is called for received from the underlying transport.

connectionThe connection that received the data.
dataThe data received.

Implements ConnectionDataHandler.

Definition at line 121 of file socks5bytestream.cpp.

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.

timeoutThe timeout to use for select in microseconds. Default of -1 means blocking.
The state of the connection.

Implements Bytestream.

Definition at line 95 of file socks5bytestream.cpp.

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.

dataThe block of data to send.
True if the data has been sent (no guarantee of receipt), false in case of an error.

Implements Bytestream.

Definition at line 87 of file socks5bytestream.cpp.

void setConnectionImpl ( ConnectionBase connection)

Sets the connection to use.

connectionThe 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)

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: