com.openinventor.remoteviz.rendering

Class ServiceListener

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.ServiceListener

public class ServiceListener
extends Inventor

This virtual class enables an application to receive notifications from the rendering Service. A typical sequence of calls is:

• onConnectedClient
• onPendingCreateRenderArea
• onInstantiatedRenderArea
• onInitializedClient
  
  Application is running...
  
  
• onDisposedRenderArea
• onDisconnectedClient

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
ServiceListener() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	onConnectedClient(java.lang.String clientId, NetworkPerformance networkPerformance) Triggered when a client is connected to the service.
void	onDisconnectedClient(java.lang.String clientId) Triggered when a client is disconnected from the service.
void	onDisposedRenderArea(java.lang.String renderAreaId) Triggered when a renderArea has been disposed.
void	onDisposingRenderArea(RenderArea renderArea) Triggered before a renderArea is disposed.
void	onInitializedClient(Client client, NetworkPerformance networkPerformance) Triggered when a client is initialized.
void	onInstantiatedRenderArea(RenderArea renderArea) Triggered when a renderArea has been instantiated.
void	onMissingLicense(java.lang.String renderAreaId, ConnectionParameters parameters) Triggered when a new connection is requested and a RemoteViz license was not found.
boolean	onPendingCreateRenderArea(java.lang.String renderAreaId, int[] size, RenderAreaHardware renderAreaHardware, Client client, ConnectionParameters parameters) Triggered when a connection is pending and the requested renderArea does not exist.\n\n Default behavior : accept the connection by returning true.
boolean	onPendingShareRenderArea(RenderArea renderArea, Client client, ConnectionParameters parameters) Triggered when a connection is pending and the requested renderArea exists.
java.lang.String	onRequestedPrivateKeyPassphrase() Triggered when the secure connection is enabled.

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceListener

public ServiceListener()

Default constructor.

Method Detail

onPendingCreateRenderArea

public boolean onPendingCreateRenderArea(java.lang.String renderAreaId,
                                         int[] size,
                                         RenderAreaHardware renderAreaHardware,
                                         Client client,
                                         ConnectionParameters parameters)

Triggered when a connection is pending and the requested renderArea does not exist.\n\n Default behavior : accept the connection by returning true.

Parameters:

renderAreaId - ID identifying the renderArea requested by the client

size - client requested width (size[0]) and height ( size[1]) if the connection parameters contain this information, otherwise it's the renderArea default size. This value can be modified, it determines the created RenderArea size.

client - client that is being connected to the service. If the client does not exist yet, the pointer value will be NULL.

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.\n

If there are no listeners to call, the connection will be accepted.\n

IMPORTANT : This callback must not contain any calls to the OpenInventor library.

onInstantiatedRenderArea

public void onInstantiatedRenderArea(RenderArea renderArea)

Triggered when a renderArea has been instantiated.

Default behavior : do nothing

Parameters:

renderArea - : pointer to the instantiated renderArea

onPendingShareRenderArea

public boolean onPendingShareRenderArea(RenderArea renderArea,
                                        Client client,
                                        ConnectionParameters parameters)

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.

onInitializedClient

public void onInitializedClient(Client client,
                                NetworkPerformance networkPerformance)

Triggered when a client is initialized.

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

Parameters:

client - : client that is being connected to the service.

networkPerformance - : network performance for the client.
Network performance measures can be retrieved. (see NetworkPerformance.getBandwidth and NetworkPerformance.getLatency)

onMissingLicense

public void onMissingLicense(java.lang.String renderAreaId,
                             ConnectionParameters parameters)

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.

onConnectedClient

public void onConnectedClient(java.lang.String clientId,
                              NetworkPerformance networkPerformance)

Triggered when a client is connected to the service.

Default behavior : do nothing

Parameters:

clientId - : ID identifying the client

networkPerformance - : network performance for the client.
Network calibration can be enabled or disabled from this parameter. (see NetworkPerformance.enableCalibration and NetworkPerformance.setMaxCalibrationDuration)

onDisconnectedClient

public void onDisconnectedClient(java.lang.String clientId)

Triggered when a client is disconnected from the service.

Default behavior : do nothing

Parameters:

clientId - : ID identifying the client

onDisposingRenderArea

public void onDisposingRenderArea(RenderArea renderArea)

Triggered before a renderArea is disposed. See RenderArea.closeConnectionsAndDispose. This listener is called before onDisposedRenderArea.

Default behavior : do nothing

Parameters:

renderArea - : pointer to the renderArea

onRequestedPrivateKeyPassphrase

public java.lang.String onRequestedPrivateKeyPassphrase()

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.

onDisposedRenderArea

public void onDisposedRenderArea(java.lang.String renderAreaId)

Triggered when a renderArea has been disposed. See RenderArea.closeConnectionsAndDispose. This listener is called after onDisposingRenderArea.

Default behavior : do nothing

Parameters:

renderAreaId - : ID identifying the disposed renderArea