#include <bytestream.h>
Public Types | |
| enum | StreamType { S5B , IBB } |
Public Member Functions | |
| Bytestream (StreamType type, LogSink &logInstance, const JID &initiator, const JID &target, const std::string &sid) | |
| virtual | ~Bytestream () |
| bool | isOpen () const |
| virtual bool | connect ()=0 |
| virtual void | close ()=0 |
| virtual bool | send (const std::string &data)=0 |
| virtual ConnectionError | recv (int timeout=-1)=0 |
| const std::string & | sid () const |
| StreamType | type () const |
| const JID & | target () const |
| const JID & | initiator () const |
| void | registerBytestreamDataHandler (BytestreamDataHandler *bdh) |
| void | removeBytestreamDataHandler () |
Protected Attributes | |
| BytestreamDataHandler * | m_handler |
| const LogSink & | m_logInstance |
| const JID | m_initiator |
| const JID | m_target |
| StreamType | m_type |
| std::string | m_sid |
| bool | m_open |
Detailed Description
An abstraction of a single bytestream.
Used as a base class for InBand Bytestreams as well as SOCKS5 Bytestreams. You should not need to use this class directly.
- Since
- 1.0
Definition at line 36 of file bytestream.h.
Member Enumeration Documentation
◆ StreamType
| enum StreamType |
Available stream types.
| Enumerator | |
|---|---|
| S5B | SOCKS5 Bytestream |
| IBB | In-Band Bytestream |
Definition at line 42 of file bytestream.h.
Constructor & Destructor Documentation
◆ Bytestream()
|
inline |
Creates a new Bytestream.
- Parameters
-
type The stream type. logInstance A Logsink to use for logging. Obtain it from ClientBase::logInstance(). initiator The initiator of the stream (usually the sender). target The target of the stream (usually the receiver). sid The stream's ID.
Definition at line 56 of file bytestream.h.
◆ ~Bytestream()
|
inlinevirtual |
Virtual destructor.
Definition at line 65 of file bytestream.h.
Member Function Documentation
◆ close()
|
pure virtual |
Closes the bytestream.
Implemented in SOCKS5Bytestream, and InBandBytestream.
◆ connect()
|
pure virtual |
This function starts the connection process.
- Returns
- True if a connection to a remote entity could be established, false otherwise.
- Note
- If false is returned you should pass this Bytestream object to SIProfileFT::dispose() for deletion.
- Make sure you have a BytestreamDataHandler registered (using registerBytestreamDataHandler()) before calling this function.
Implemented in SOCKS5Bytestream, and InBandBytestream.
◆ initiator()
|
inline |
◆ isOpen()
|
inline |
Returns whether the bytestream is open, that is, accepted by both parties and ready to send/receive data.
- Returns
- Whether or not the bytestream is open.
Definition at line 72 of file bytestream.h.
◆ recv()
|
pure virtual |
Call this function repeatedly to receive data. You should even do this if you use the bytestream to merely send data. May be a NOOP, depending on the actual stream type.
- Parameters
-
timeout The timeout to use for select in microseconds. Default of -1 means blocking.
- Returns
- The state of the connection.
Implemented in SOCKS5Bytestream, and InBandBytestream.
◆ registerBytestreamDataHandler()
|
inline |
Use this function to register an object that will receive any notifications from the Bytestream instance. Only one BytestreamDataHandler can be registered at any one time.
- Parameters
-
bdh The BytestreamDataHandler-derived object to receive notifications.
Definition at line 142 of file bytestream.h.
◆ removeBytestreamDataHandler()
|
inline |
Removes the registered BytestreamDataHandler.
Definition at line 148 of file bytestream.h.
◆ send()
|
pure virtual |
Use this function to send a chunk of data over an open bytestream. If the stream is not open or has been closed again (by the remote entity or locally), nothing is sent and false is returned. This function does any base64 encoding for you, if necessary.
- 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.
Implemented in SOCKS5Bytestream, and InBandBytestream.
◆ sid()
|
inline |
Lets you retrieve the stream's ID.
- Returns
- The stream's ID.
Definition at line 114 of file bytestream.h.
◆ target()
|
inline |
◆ type()
|
inline |
Member Data Documentation
◆ m_handler
|
protected |
A handler for incoming data and open/close events.
Definition at line 153 of file bytestream.h.
◆ m_initiator
|
protected |
The initiator's JID.
Definition at line 159 of file bytestream.h.
◆ m_logInstance
|
protected |
A LogSink instance to use for logging.
Definition at line 156 of file bytestream.h.
◆ m_open
|
protected |
Indicates whether or not the stream is open.
Definition at line 171 of file bytestream.h.
◆ m_sid
|
protected |
The stream ID.
Definition at line 168 of file bytestream.h.
◆ m_target
|
protected |
The target's JID.
Definition at line 162 of file bytestream.h.
◆ m_type
|
protected |
The stream type.
Definition at line 165 of file bytestream.h.
The documentation for this class was generated from the following file:
