RemoteViz::Rendering::NetworkPerformance Class Reference
[RemoteViz]
#include <RemoteViz/Rendering/NetworkPerformance.h>
|
| |
| void | enableCalibration (bool val) |
| bool | isCalibrationEnabled () const |
| void | setMaxCalibrationDuration (unsigned int val) |
| unsigned int | getMaxCalibrationDuration () const |
| unsigned int | getBandwidth () const |
| unsigned int | getLatency () const |
Detailed Description
This class refers to measures of service quality of the network.
Member Function Documentation
| void RemoteViz::Rendering::NetworkPerformance::enableCalibration | ( | bool | 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 also:
- ServiceListener::onConnectedClient
| unsigned int RemoteViz::Rendering::NetworkPerformance::getBandwidth | ( | ) | const |
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
| unsigned int RemoteViz::Rendering::NetworkPerformance::getLatency | ( | ) | const |
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
| unsigned int RemoteViz::Rendering::NetworkPerformance::getMaxCalibrationDuration | ( | ) | const |
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
| bool RemoteViz::Rendering::NetworkPerformance::isCalibrationEnabled | ( | ) | const |
Return if the network performance calibration is enabled.
- Returns:
- true if enabled, false if disabled
| void RemoteViz::Rendering::NetworkPerformance::setMaxCalibrationDuration | ( | unsigned 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
The documentation for this class was generated from the following file:
- RemoteViz/Rendering/NetworkPerformance.h