Package com.openinventor.remoteviz.rendering

Class MetricsListener

java.lang.Object
com.openinventor.inventor.Inventor
com.openinventor.remoteviz.rendering.MetricsListener
public class MetricsListener extends Inventor
This class can be overridden by an application to monitor the service. These listeners allow to report states and performances metrics of the service. The metrics/listeners can be enabled using Monitoring.enableMetrics. The overridden class will be passed as argument to the method Monitoring.addListener.

The metrics are triggered in the service thread, so costly operations in the listeners could impact global performances of the service.

This class is an abstract class which must be overridden.

See $OIVHOME/examples/source/RemoteViz/Monitoring

See Also:

  • Constructor Details

    • MetricsListener

      public MetricsListener()
      Default constructor.

  • Method Details

    • onMeasuredNetworkLatency

      public void onMeasuredNetworkLatency(int time, Client client)
      Triggered when a new measure of network latency is available. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.NETWORK_LATENCY.

      Parameters:
      time - : network latency in milliseconds

      client - : The network latency is related to this client.

    • onChangedNumClients

      public void onChangedNumClients(int number)
      Triggered when the number of clients changes. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.NUM_CLIENTS.

      Parameters:
      number - : number of clients

    • onMeasuredRenderingTime

      public void onMeasuredRenderingTime(int time, RenderArea renderArea)
      Triggered when a new measure of frame rendering time is available. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.RENDERING_TIME.

      Parameters:
      time - : frame rendering time in milliseconds

      renderArea - : The frame rendering time is related to this render area.

    • onChangedNumConnections

      public void onChangedNumConnections(int number)
      Triggered when the number of connections changes. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.NUM_CONNECTIONS.

      Parameters:
      number - : number of connections

    • onMeasuredEncodingTime

      public void onMeasuredEncodingTime(int time, Connection connection)
      Triggered when a new measure of frame encoding time is available. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.ENCODING_TIME.

      Parameters:
      time - : frame encoding time in milliseconds

      connection - : The frame encoding time is related to this connection.

    • onMeasuredDecodingTime

      public void onMeasuredDecodingTime(int time, Connection connection)
      Triggered when a new measure of frame decoding time is available. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.DECODING_TIME.

      Parameters:
      time - : frame decoding time in milliseconds

      connection - : The frame decoding time is related to this connection.

    • onChangedNumRenderAreas

      public void onChangedNumRenderAreas(int number)
      Triggered when the number of renderArea changes. The metric must be enabled using Monitoring.enableMetrics with the value Monitoring.NUM_RENDERAREAS.

      Parameters:
      number - : number of render areas