VRS::TwoPointConnection Class Reference
#include <vrs/qt3/twopointconnection.h>
Detailed Description
A TwoPointConnection is a simple interface for a TCP/IP-network connecting two hosts. To establish a connection, the following steps are necessary:- The one host constructs a TwoPointConnection using the port-constructor
- The other host constructs a TwoPointConnection using the (host,port) constructor to connect with the other.
- Both hosts can simply use the streaming operators "<<" and ">>" to exchange data with each other. If you have streamed data to the TwoPointConnection, you must call the flush() method, so that the data is sent to the other. Alternatively you can set the flushThreshold to a value 'n', so that after streaming in of 'n' bytes flush() is automatically called.
Member Enumeration Documentation
Constructor & Destructor Documentation
| VRS::TwoPointConnection::TwoPointConnection | ( | ) |
Creates an TwopointConnection. It is idle until one of the start() methods is called.
| virtual VRS::TwoPointConnection::~TwoPointConnection | ( | ) | [virtual] |
Member Function Documentation
| void VRS::TwoPointConnection::start | ( | int | port | ) |
Sets up a server on the specified port */.
| void VRS::TwoPointConnection::start | ( | std::string | host, | |
| int | port | |||
| ) |
Connects two a server on the specified host and the specified port.
| void VRS::TwoPointConnection::stop | ( | ) |
Stops the current connection.
| int VRS::TwoPointConnection::bytesReceived | ( | ) | const |
Number of received bytes waiting in the buffer for being streamed.
| bool VRS::TwoPointConnection::connected | ( | ) | const |
Indicates the connection status.
| void VRS::TwoPointConnection::flush | ( | ) |
Sends the in streamed data.
| void VRS::TwoPointConnection::setFlushThreshold | ( | unsigned int | size = 0 |
) |
Set the autoFlush constant. Setting it to 0 disables auto flush.
| unsigned int VRS::TwoPointConnection::getFlushThreshold | ( | ) | const |
Return the autoFlush constant.
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | VRS::UINT8 | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | VRS::UINT16 | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | VRS::UINT32 | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | VRS::UINT64 | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | float | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | double | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | bool | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | Vector | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator<< | ( | SO< SharedObj > | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | VRS::UINT8 & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | VRS::UINT16 & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | VRS::UINT32 & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | VRS::UINT64 & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | float & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | double & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | bool & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | Vector & | ) |
| TwoPointConnection& VRS::TwoPointConnection::operator>> | ( | SO< SharedObj > & | ) |
| void VRS::TwoPointConnection::restore | ( | VRS::UINT8 | ) |
| void VRS::TwoPointConnection::restore | ( | VRS::UINT16 | ) |
| void VRS::TwoPointConnection::restore | ( | VRS::UINT32 | ) |
| void VRS::TwoPointConnection::restore | ( | VRS::UINT64 | ) |
| void VRS::TwoPointConnection::restore | ( | float | ) |
| void VRS::TwoPointConnection::restore | ( | double | ) |
| void VRS::TwoPointConnection::restore | ( | bool | ) |
| void VRS::TwoPointConnection::restore | ( | std::string | ) |
| void VRS::TwoPointConnection::restore | ( | Vector | ) |
If you receive data of variable length it can be useful to check data without streaming them out. For example if you store the byte size s of a message first, you should wait until you can stream out the complete message. But you must be able to check the size info without removing it from the stream. So you can give it back by the "restore" method if the message is not completely received.
| void VRS::TwoPointConnection::sendString | ( | const std::string & | s | ) |
Sends a 0-terminated string.
| bool VRS::TwoPointConnection::receiveString | ( | std::string & | s | ) |
Receives a 0-terminated string and stores it in 's'. If the string is not completely received yet, 's' is left unchanged and 'false' is returned.
Similar to the callback mechanism of SharedObj, you can register a callback that is called each time when data arrive.
Removes a callback from the callback list.
This callback is invoked if the socket connection ends.
Removes a callback from the callback list.
This callback is invoked when a connection attempt was successful (client mode) or when a client has connected (server mode).
Unregisters a registered connection callback.
Called when a network error occurs.
Unregisters a registered error callback.
| VRS::TwoPointConnection::VRS_SERIALIZABLE_CLASS_ENUM | ( | NetworkError | ) |
| NetworkError VRS::TwoPointConnection::getLastError | ( | ) | const |
| VRS::TwoPointConnection::VRS_TYPEINFO | ( | TwoPointConnection | , | |
| SharedObj | ||||
| ) |
Friends And Related Function Documentation
friend class ImplClient [friend] |
The documentation for this class was generated from the following file: