RemoteViz::Rendering::Connection Class Reference
[RemoteViz]

RemoteViz More...

#include <RemoteViz/Rendering/Connection.h>

List of all members.

Public Member Functions

const std::string & getId () const
ConnectionSettingsgetSettings () const
ConnectionParametersgetParameters () const
RenderAreagetRenderArea () const
unsigned int getRequestedWidth () const
unsigned int getRequestedHeight () const
unsigned int getContainerWidth () const
unsigned int getContainerHeight () const
ClientgetClient () const
bool sendMessage (const std::string &message) const
bool sendMessage (const unsigned char *buffer, size_t size) const
void close ()
EncodedFrame getLastEncodedFrame () const

Detailed Description

RemoteViz

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.


Member Function Documentation

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.

Returns:
the ID identifying the client
unsigned int RemoteViz::Rendering::Connection::getContainerHeight (  )  const

Gets the client container height.

Returns:
the client container height
unsigned int RemoteViz::Rendering::Connection::getContainerWidth (  )  const

Gets the client container width.

Returns:
the client container width
const std::string& RemoteViz::Rendering::Connection::getId (  )  const

Gets the id of the connection.

Returns:
the ID identifying the connection
EncodedFrame RemoteViz::Rendering::Connection::getLastEncodedFrame (  )  const

Gets the last encoded frame sent by the connection.

Returns:
encoded frame.
ConnectionParameters* RemoteViz::Rendering::Connection::getParameters (  )  const

Gets the connection parameters (field-value pairs included in the url during the client connection).

Returns:
a pointer to the connection parameters
RenderArea* RemoteViz::Rendering::Connection::getRenderArea (  )  const

Gets the RenderArea associated with the connection.

Returns:
a pointer to the renderArea
unsigned int RemoteViz::Rendering::Connection::getRequestedHeight (  )  const

Gets the last renderArea height requested by the client.

Returns:
the requested renderArea height
unsigned int RemoteViz::Rendering::Connection::getRequestedWidth (  )  const

Gets the last renderArea width requested by the client.

Returns:
the requested renderArea width
ConnectionSettings* RemoteViz::Rendering::Connection::getSettings (  )  const

Gets the connection settings.

Returns:
a pointer to the connection settings
bool RemoteViz::Rendering::Connection::sendMessage ( const unsigned char *  buffer,
size_t  size 
) const

Sends a binary message to the client.

The client-side message event will be triggered.

Parameters:
buffer : the binary message to be sent to the client
size : the size of the message
Returns:
true if the message has been successfully sent, otherwise returns false.
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.

Parameters:
message : the message to be sent to the client
Returns:
true if the message has been successfully sent, otherwise returns false.

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

Open Inventor Toolkit reference manual, generated on 22 Mar 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/