RemoteViz::Rendering::MetricsListener Class Reference

More...

#include <RemoteViz/Rendering/MetricsListener.h>

Public Member Functions
virtual	~MetricsListener ()
	Destructor.
virtual void	onMeasuredNetworkLatency (unsigned int time, std::shared_ptr< Client > client)
	Triggered when a new measure of network latency is available.
virtual void	onMeasuredDecodingTime (unsigned int time, std::shared_ptr< Connection > connection)
	Triggered when a new measure of frame decoding time is available.
virtual void	onMeasuredRenderingTime (unsigned int time, std::shared_ptr< RenderArea > renderArea)
	Triggered when a new measure of frame rendering time is available.
virtual void	onMeasuredEncodingTime (unsigned int time, std::shared_ptr< Connection > connection)
	Triggered when a new measure of frame encoding time is available.
virtual void	onChangedNumClients (unsigned int number)
	Triggered when the number of clients changes.
virtual void	onChangedNumConnections (unsigned int number)
	Triggered when the number of connections changes.
virtual void	onChangedNumRenderAreas (unsigned int number)
	Triggered when the number of renderArea changes.

Detailed Description

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

Monitoring

Definition at line 58 of file MetricsListener.h.

Constructor & Destructor Documentation

~MetricsListener()

virtual RemoteViz::Rendering::MetricsListener::~MetricsListener ( )

virtual

Destructor.

Member Function Documentation

onChangedNumClients()

virtual void RemoteViz::Rendering::MetricsListener::onChangedNumClients ( unsigned int  number )

virtual

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

onChangedNumConnections()

virtual void RemoteViz::Rendering::MetricsListener::onChangedNumConnections ( unsigned int  number )

virtual

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

onChangedNumRenderAreas()

virtual void RemoteViz::Rendering::MetricsListener::onChangedNumRenderAreas ( unsigned int  number )

virtual

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

onMeasuredDecodingTime()

virtual void RemoteViz::Rendering::MetricsListener::onMeasuredDecodingTime ( unsigned int  time, std::shared_ptr< Connection >  connection  )

virtual

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.

onMeasuredEncodingTime()

virtual void RemoteViz::Rendering::MetricsListener::onMeasuredEncodingTime ( unsigned int  time, std::shared_ptr< Connection >  connection  )

virtual

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.

onMeasuredNetworkLatency()

virtual void RemoteViz::Rendering::MetricsListener::onMeasuredNetworkLatency ( unsigned int  time, std::shared_ptr< Client >  client  )

virtual

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.

onMeasuredRenderingTime()

virtual void RemoteViz::Rendering::MetricsListener::onMeasuredRenderingTime ( unsigned int  time, std::shared_ptr< RenderArea >  renderArea  )

virtual

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.

---

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

• RemoteViz/Rendering/MetricsListener.h