#include <RemoteViz/Rendering/Connection.h>
Public Member Functions | |
const std::string & | getId () const |
ConnectionSettings * | getSettings () const |
ConnectionParameters * | getParameters () const |
RenderArea * | getRenderArea () const |
unsigned int | getRequestedWidth () const |
unsigned int | getRequestedHeight () const |
unsigned int | getContainerWidth () const |
unsigned int | getContainerHeight () const |
Client * | getClient () const |
bool | sendMessage (const std::string &message) const |
void | close () |
EncodedFrame | getLastEncodedFrame () const |
Represents a connection from a Client to a RenderArea managed by the RemoteViz service.
RemoteViz is protected by the Open Inventor license key mechanism limiting its usage to specified computers or network environments based on commercial agreements. RemoteViz uses floating licenses managed by a license server or an encrypted "master password" string (see SoLockManager).
Each Connection requires one RemoteViz license (an SDK license for development/debugging or Runtime license for deployment).
If no license is found, the listener ServiceListener::onMissingLicense will be triggered.
void RemoteViz::Rendering::Connection::close | ( | ) |
Closes the connection.
A KICKED disconnect message will be sent to the client.
Client* RemoteViz::Rendering::Connection::getClient | ( | ) | const |
Gets the id of the client associated with the connection.
unsigned int RemoteViz::Rendering::Connection::getContainerHeight | ( | ) | const |
Gets the client container height.
unsigned int RemoteViz::Rendering::Connection::getContainerWidth | ( | ) | const |
Gets the client container width.
const std::string& RemoteViz::Rendering::Connection::getId | ( | ) | const |
Gets the id of the connection.
EncodedFrame RemoteViz::Rendering::Connection::getLastEncodedFrame | ( | ) | const |
Gets the last encoded frame sent by the connection.
ConnectionParameters* RemoteViz::Rendering::Connection::getParameters | ( | ) | const |
Gets the connection parameters (field-value pairs included in the url during the client connection).
RenderArea* RemoteViz::Rendering::Connection::getRenderArea | ( | ) | const |
Gets the RenderArea associated with the connection.
unsigned int RemoteViz::Rendering::Connection::getRequestedHeight | ( | ) | const |
Gets the last renderArea height requested by the client.
unsigned int RemoteViz::Rendering::Connection::getRequestedWidth | ( | ) | const |
Gets the last renderArea width requested by the client.
ConnectionSettings* RemoteViz::Rendering::Connection::getSettings | ( | ) | const |
Gets the connection settings.
bool RemoteViz::Rendering::Connection::sendMessage | ( | const std::string & | message | ) | const |
Sends a text message to the client.
The client-side message event will be triggered.
message | : the message to be sent to the client |