SOCKS5BytestreamDataHandler Class Reference

A virtual interface that allows implementors to receive data sent over a SOCKS5 Bytestream as defined in XEP-0066. You'll also need it for sending of data. More...

#include <socks5bytestreamdatahandler.h>

List of all members.

Public Member Functions
virtual	~SOCKS5BytestreamDataHandler ()
virtual void	handleSOCKS5Data (SOCKS5Bytestream *s5b, const std::string &data)=0
virtual void	handleSOCKS5Error (SOCKS5Bytestream *s5b, Stanza *stanza)=0
virtual void	handleSOCKS5Open (SOCKS5Bytestream *s5b)=0
virtual void	handleSOCKS5Close (SOCKS5Bytestream *s5b)=0

---

Detailed Description

A virtual interface that allows implementors to receive data sent over a SOCKS5 Bytestream as defined in XEP-0066. You'll also need it for sending of data.

An SOCKS5BytestreamDataHandler is registered with a SOCKS5Bytestream.

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

Author:

Jakob Schroeter <js@camaya.net>

Since:

0.9

Definition at line 39 of file socks5bytestreamdatahandler.h.

---

Constructor & Destructor Documentation

virtual ~SOCKS5BytestreamDataHandler

(

)

[inline, virtual]

Virtual destructor.

Definition at line 45 of file socks5bytestreamdatahandler.h.

---

Member Function Documentation

virtual void handleSOCKS5Data	(	SOCKS5Bytestream *	s5b,
		const std::string &	data
	)			[pure virtual]

Reimplement this function to receive data which is sent over the bytestream. The data received here is (probably) only a single chunk of the complete data (depending on the amount of data you want to send).

Parameters:

	s5b	The bytestream.
	data	The actual stream payload.

virtual void handleSOCKS5Error	(	SOCKS5Bytestream *	s5b,
		Stanza *	stanza
	)			[pure virtual]

Notifies about an error occuring while using a bytestream. When this handler is called the stream has already been closed.

Parameters:

	s5b	The bytestream.
	stanza	The error stanza.

virtual void handleSOCKS5Open

(

SOCKS5Bytestream *

s5b

)

[pure virtual]

Notifies the handler that the given bytestream has been acknowledged and is ready to send/receive data.

Parameters:

s5b

The opened bytestream.

virtual void handleSOCKS5Close

(

SOCKS5Bytestream *

s5b

)

[pure virtual]

Notifies the handler that the given bytestream has been closed.

Parameters:

s5b

The closed bytestream.

---

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

• socks5bytestreamdatahandler.h