Apache REEF  0.16.0
Retainable Evaluator Execution Framework
Public Member Functions | List of all members
Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IDoubleGauge Interface Reference

Interface to implement the double gauge. More...

Inherits Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMutableMetric.

Inherited by Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.MutableDoubleGauge.

Public Member Functions

void Increment ()
 Increments the gauge by 1. More...
 
void Increment (double delta)
 Increments the gauge by delta. More...
 
void Decrement ()
 Decrements the gauge by 1. More...
 
void Decrement (double delta)
 Decrements the gauge by delta. More...
 
void Reset (double value)
 Resets the gauge. More...
 
- Public Member Functions inherited from Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMutableMetric
void Subscribe (IObservable< SnapshotRequest > requestor)
 This function should be used to subscribe metric tot he observable, typically IMetricsSource More...
 

Additional Inherited Members

- Properties inherited from Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IMutableMetric
IMetricsInfo Info [get]
 Meta-data of the metric. More...
 

Detailed Description

Interface to implement the double gauge.

A user will only work against this interface. Implementations will be internal.

Member Function Documentation

◆ Decrement() [1/2]

void Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IDoubleGauge.Decrement ( )

Decrements the gauge by 1.

◆ Decrement() [2/2]

void Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IDoubleGauge.Decrement ( double  delta)

Decrements the gauge by delta.

Parameters
deltaValue with which to increment.

◆ Increment() [1/2]

void Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IDoubleGauge.Increment ( )

Increments the gauge by 1.

◆ Increment() [2/2]

void Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IDoubleGauge.Increment ( double  delta)

Increments the gauge by delta.

Parameters
deltaValue with which to increment.

◆ Reset()

void Org.Apache.REEF.Common.Metrics.MutableMetricsLayer.IDoubleGauge.Reset ( double  value)

Resets the gauge.

Parameters
valueValue to which the gauge should be reset.

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