MetricsListener Class |
This class can be overridden by an application to monitor the service.
Namespace: OIV.RemoteViz.Rendering
The MetricsListener type exposes the following members.
Name | Description | |
---|---|---|
MetricsListener | Default constructor. |
Name | Description | |
---|---|---|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
OnChangedNumClients | Triggered when the number of clients changes. | |
OnChangedNumConnections | Triggered when the number of connections changes. | |
OnChangedNumRenderAreas | Triggered when the number of renderArea changes. | |
OnMeasuredDecodingTime | Triggered when a new measure of frame decoding time is available. | |
OnMeasuredEncodingTime | Triggered when a new measure of frame encoding time is available. | |
OnMeasuredNetworkLatency | Triggered when a new measure of network latency is available. | |
OnMeasuredRenderingTime | Triggered when a new measure of frame rendering time is available. | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
These listeners allow to report states and performances metrics of the service. The metrics/listeners can be enabled using OIV.RemoteViz.Rendering.Monitoring.EnableMetrics(OIV.RemoteViz.Rendering.Monitoring.MetricTypes). The overridden class will be passed as argument to the method OIV.RemoteViz.Rendering.Monitoring.AddListener(OIV.RemoteViz.Rendering.MetricsListener).
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