com.openinventor.remoteviz.rendering

Class NetworkPerformance

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.remoteviz.rendering.NetworkPerformance

public class NetworkPerformance
extends Inventor

This class manages measures of service quality of the network. To get an instance of this class, implement the ServiceListener.onConnectedClient() method.

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

Method Summary

Modifier and Type	Method and Description
void	enableCalibration(boolean val) Enable or disable network performance calibration.
int	getBandwidth() Gets the estimated network bandwidth between the service and the client.
int	getLatency() Gets the estimated network latency (round-trip time) between the service and the client.
int	getMaxCalibrationDuration() Gets the network performance calibration maximum duration.
boolean	isCalibrationEnabled() Return if the network performance calibration is enabled.
void	setMaxCalibrationDuration(int val) Sets the network performance calibration maximum duration.

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

Method Detail

isCalibrationEnabled

public boolean isCalibrationEnabled()

Return if the network performance calibration is enabled.

Returns:

true if enabled, false if disabled

enableCalibration

public void enableCalibration(boolean val)

Enable or disable network performance calibration. Default value is true.
If calibration is enabled, a measurement of the latency and bandwidth is performed after the first connection establishment and before sending frames.

Parameters:

val - : true to enable, false to disable@see com.openinventor.remoteviz.rendering.ServiceListener#onConnectedClient(java.lang.String, com.openinventor.remoteviz.rendering.NetworkPerformance) ServiceListener.onConnectedClient

getMaxCalibrationDuration

public int getMaxCalibrationDuration()

Gets the network performance calibration maximum duration. Default value is 5 seconds.
Frames will be send to the client after this duration.

Returns:

the calibration maximum duration in milliseconds

getBandwidth

public int getBandwidth()

Gets the estimated network bandwidth between the service and the client.
This value 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.
This value is estimated during the network calibration step.

Returns:

the network bandwidth in bit per seconds

setMaxCalibrationDuration

public void setMaxCalibrationDuration(int val)

Sets the network performance calibration maximum duration. Default value is 5 seconds.
Frames will be send to the client after this duration.

Parameters:

val - : max calibration duration in milliseconds

getLatency

public int getLatency()

Gets the estimated network latency (round-trip time) between the service and the client. This value influences the quality of interactions. The lower the value, the better the user interactions. This value is estimated during the network calibration step.

Returns:

the network latency in milliseconds