RemoteViz::Rendering::Monitoring Class Reference
[RemoteViz]

Public Types
enum	MetricType { NONE = 0x00, NETWORK_LATENCY = 0x1, DECODING_TIME = 0x2, RENDERING_TIME = 0x4, ENCODING_TIME = 0x8, NUM_CLIENTS = 0x10, NUM_CONNECTIONS = 0x20, NUM_RENDERAREAS = 0x40, ALL = 0xFFFF }
Public Member Functions
void	addListener (std::shared_ptr< MetricsListener > listener)
void	removeListener (std::shared_ptr< MetricsListener > listener)
unsigned int	getNumListeners () const
void	enableMetrics (unsigned int mask)
bool	isMetricEnabled (MetricType metric) const

Detailed Description

This class enables to manage metrics listeners that monitor states and performance of the service.

See $OIVHOME/examples/source/RemoteViz/Monitoring

Types of metrics.

Enumerator:

void RemoteViz::Rendering::Monitoring::addListener ( std::shared_ptr< MetricsListener > listener )

Adds a listener for metrics.

Parameters:

listener

: shared_ptr pointer to the class that implements MetricsListener

void RemoteViz::Rendering::Monitoring::enableMetrics ( unsigned int mask )

Enable metrics By default, all metrics are disabled.

Parameters:

mask

: binary mask of MetricType

unsigned int RemoteViz::Rendering::Monitoring::getNumListeners ( ) const

Return the number of listeners.

bool RemoteViz::Rendering::Monitoring::isMetricEnabled ( MetricType metric ) const

Check if a metric is enabled.

Parameters:

metric

: metric to check

Return true if the metric is enabled, false otherwise

void RemoteViz::Rendering::Monitoring::removeListener ( std::shared_ptr< MetricsListener > listener )

Removes a listener for metrics.

Parameters:

listener

: shared_ptr pointer to the class that implements MetricsListener

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