RemoteViz::Rendering::ServiceListener Class Reference
[RemoteViz]

RemoteViz More...

#include <RemoteViz/Rendering/ServiceListener.h>

List of all members.

Public Member Functions

virtual ~ServiceListener ()
virtual bool onPendingCreateRenderArea (const std::string &renderAreaId, unsigned int &width, unsigned int &height, std::shared_ptr< RenderAreaHardware > renderAreaHardware, std::shared_ptr< Client > client, std::shared_ptr< const ConnectionParameters > parameters)
virtual bool onPendingShareRenderArea (std::shared_ptr< RenderArea > renderArea, std::shared_ptr< Client > client, std::shared_ptr< const ConnectionParameters > parameters)
virtual void onInstantiatedRenderArea (std::shared_ptr< RenderArea > renderArea)
virtual void onDisposingRenderArea (std::shared_ptr< RenderArea > renderArea)
virtual void onDisposedRenderArea (const std::string &renderAreaId)
virtual void onConnectedClient (const std::string &clientId, std::shared_ptr< NetworkPerformance > networkPerformance)
virtual void onInitializedClient (std::shared_ptr< Client > client, std::shared_ptr< const NetworkPerformance > networkPerformance)
virtual void onDisconnectedClient (const std::string &clientId)
virtual void onMissingLicense (const std::string &renderAreaId, std::shared_ptr< const ConnectionParameters > parameters)
virtual std::string onRequestedPrivateKeyPassphrase ()
virtual HTTPResponse onHTTPRequest (std::shared_ptr< const HTTPRequest > httpRequest)

Detailed Description

RemoteViz

This virtual class enables an application to receive notifications from the rendering Service.

A typical sequence of calls to this listener is:

Since RemoteViz 10.6, this class also allows the Service to respond to standard HTTP requests using standard HTTP response codes (and messages). This can be useful, for example, to respond to "health check" requests. This method is not suitable to serve high volume requests or HTTP resources, in these cases, prefer a dedicated HTTP server like Apache or Nginx. See onHTTPRequest().

Typically the application will attach a listener to the Service instance before calling the Service's open() method.

For notifications about connections, rendering, input events and client messages see the RenderAreaListener class.


Constructor & Destructor Documentation

virtual RemoteViz::Rendering::ServiceListener::~ServiceListener (  )  [virtual]

Destructor.


Member Function Documentation

virtual void RemoteViz::Rendering::ServiceListener::onConnectedClient ( const std::string &  clientId,
std::shared_ptr< NetworkPerformance networkPerformance 
) [virtual]

Triggered when a client is connected to the service.



Default behavior : do nothing

If network performance calibration is enabled, the network bandwidth is measured after this call and before calling onInitializedClient. Therefore the NetworkPerformance queries getBandwidth and getLatency will return zero at this point. Use the queries in onInitializedClient to get the measured values.

Calibration is enabled by default. Calibration can be disabled using the networkPerformance parameter (see NetworkPerformance::enableCalibration). The duration of the calibration measurement (default 5 seconds) can also be modified (see NetworkPerformance::setMaxCalibrationDuration).

Parameters:
clientId : ID identifying the client
networkPerformance : network performance for the client.
virtual void RemoteViz::Rendering::ServiceListener::onDisconnectedClient ( const std::string &  clientId  )  [virtual]

Triggered when a client is disconnected from the service.



Default behavior : do nothing

Parameters:
clientId : ID identifying the client
virtual void RemoteViz::Rendering::ServiceListener::onDisposedRenderArea ( const std::string &  renderAreaId  )  [virtual]

Triggered when a renderArea has been disposed.

See RenderArea::closeConnectionsAndDispose. At this point, the resources of the renderArea have been released. This listener is called after onDisposingRenderArea.

Default behavior : do nothing

Parameters:
renderAreaId : ID identifying the disposed renderArea
virtual void RemoteViz::Rendering::ServiceListener::onDisposingRenderArea ( std::shared_ptr< RenderArea renderArea  )  [virtual]

Triggered before a renderArea is disposed.

See RenderArea::closeConnectionsAndDispose. After disposing the renderArea, the object will be considered as "disposed" (see RenderArea::isDisposed) and will never be reused by RemoteViz internally. This listener is called before onDisposedRenderArea.

Default behavior : do nothing

Parameters:
renderArea : pointer to the renderArea
virtual HTTPResponse RemoteViz::Rendering::ServiceListener::onHTTPRequest ( std::shared_ptr< const HTTPRequest httpRequest  )  [virtual]

Triggered when an HTTP connection is made that does not attempt to upgrade the connection to the WebSocket protocol.

This allows a service to respond to these requests with regular HTTP responses. It can be useful, for example, to manage health checks:

Health checks are usually used with an external monitoring service or container orchestrator to check the status of the service. They periodically invoke the endpoint to check the health of the service instance.

In a Kubernetes environment, a pair of health checks are used that distinguish two states:

  • The service is functioning but not yet ready to receive requests. This state is the service's readiness.
  • The service is functioning and responding to requests. This state is the service's liveness.

This method is not suitable to serve high volume requests or HTTP resources, in these cases, prefer a dedicated HTTP server like Apache or Nginx. Only HTTP 1.0 features are supported (status code, method, content type and headers). Connections are terminated immediately after the response.

Default behavior : returns an HTTPResponse with "404 NOT FOUND" status.

IMPORTANT: This listener is executed in a separate thread. It gives your program the chance to perform longer calculations without blocking other network operations.

Parameters:
httpRequest HTTP request message
Returns:
HTTP response message
virtual void RemoteViz::Rendering::ServiceListener::onInitializedClient ( std::shared_ptr< Client client,
std::shared_ptr< const NetworkPerformance networkPerformance 
) [virtual]

Triggered when a client is initialized.

Default behavior : If network performance calibration is enabled NetworkPerformance::enableCalibration), the client bandwidth value (ClientSettings::setBandwidth) is set to the measured network bandwidth value (NetworkPerformance::getBandwidth).

If calibration is enabled, the network performance measures can be retrieved using the networkPerformance parameter (see NetworkPerformance::getBandwidth and NetworkPerformance::getLatency).

The client bandwidth value (ClientSettings::setBandwidth) influences the quality and the number of interactive frames sent to the client (see ConnectionSettings::setFrameEncodingPolicy). The higher the value, the better the quality and the number of interactive frames.

Parameters:
client : client that is being connected to the service.
networkPerformance : network performance for the client.
virtual void RemoteViz::Rendering::ServiceListener::onInstantiatedRenderArea ( std::shared_ptr< RenderArea renderArea  )  [virtual]

Triggered when a renderArea has been instantiated.



Default behavior : do nothing

Parameters:
renderArea : pointer to the instantiated renderArea
virtual void RemoteViz::Rendering::ServiceListener::onMissingLicense ( const std::string &  renderAreaId,
std::shared_ptr< const ConnectionParameters parameters 
) [virtual]

Triggered when a new connection is requested and a RemoteViz license was not found.

In this callback, if you release one RemoteViz license (for instance, closing another connection), the new connection will then be opened. Otherwise, a LICENSE disconnect message will be sent to the client (which can choose to notify the user).

IMPORTANT: This callback is executed in a separate thread.

RemoteViz is protected by a 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).

Default behavior : Post an error message.

virtual bool RemoteViz::Rendering::ServiceListener::onPendingCreateRenderArea ( const std::string &  renderAreaId,
unsigned int &  width,
unsigned int &  height,
std::shared_ptr< RenderAreaHardware renderAreaHardware,
std::shared_ptr< Client client,
std::shared_ptr< const ConnectionParameters parameters 
) [virtual]

Triggered when a connection is pending and the requested renderArea does not exist.



Default behavior : Accept the connection by returning true.

Use this callback to implement connection management, e.g. authentication. See the Authentication page and the ConnectionManagement example. Accepting the connection means that RemoteViz will create a RenderArea and give it the id requested by the Client (renderAreaId).

Parameters:
renderAreaId : ID identifying the renderArea requested by the client
width : client requested width if the connection parameters contain this information, otherwise it's the renderArea default width. This value can be modified, it determines the created RenderArea width.
height : client requested height if the connection parameters contain this information, otherwise it's the renderArea default height. This value can be modified, it determines the created RenderArea height.
renderAreaHardware : hardware settings used to compute the render.
client : client that is being connected to the service. If the client does not exist yet, the pointer value will be nullptr.
parameters : field-value pairs included in the url during the client connection. See connectTo function in RemoteVizRenderArea.
Returns:
true if the connection is accepted. The renderArea will be created.
Otherwise returns false. In this case, the client will be notified by an REFUSED disconnect message.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the connection will be accepted.
virtual bool RemoteViz::Rendering::ServiceListener::onPendingShareRenderArea ( std::shared_ptr< RenderArea renderArea,
std::shared_ptr< Client client,
std::shared_ptr< const ConnectionParameters parameters 
) [virtual]

Triggered when a connection is pending and the requested renderArea exists.



Default behavior : accept the connection by returning true.

Parameters:
renderArea : pointer to the renderArea
client : client that is being connected to the service. If the client does not exist yet, the pointer value will be nullptr.
parameters : field-value pairs included in the url during the client connection. See connectTo function in RemoteVizRenderArea.
Returns:
true if the connection is accepted, otherwise returns false. In this case, the client will be notified by an REFUSED disconnect message.
If there are many listeners, the logical operator OR will be applied on all the returned value of listeners.
If there are no listeners to call, the connection will be accepted.
virtual std::string RemoteViz::Rendering::ServiceListener::onRequestedPrivateKeyPassphrase (  )  [virtual]

Triggered when the secure connection is enabled.

This callback has to return the private key passphrase.

If the private key does not contain a passphrase, do not implement this callback. The default implementation will return an empty string.

Security warning !! DO NOT hard-code the passphrase into this callback !!
Read it from a SECURE location on your system.

See also:
ServiceSettings::enableSecureConnection

Default behavior : returns an empty string.


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

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