com.diffplug.common.rx

Class RateProbe

java.lang.Object

com.diffplug.common.rx.RateProbe

public class RateProbe
extends Object

A probe for inspecting rates in reactive systems.

Constructor Summary

Constructors

Constructor and Description
RateProbe()

Method Summary

Modifier and Type	Method and Description
long	fire() Fires the rate probe, and returns the elapsed time in nanoseconds since the last call.
RxGetter<Double>	rateHzOver(long timespan, TimeUnit unit) Returns the average rate in hertz over the specified time period.
RxGetter<Double>	rateHzOverNSamples(int n) Returns the average rate in hertz over the last n samples.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RateProbe

public RateProbe()

Method Detail

fire

public long fire()

Fires the rate probe, and returns the elapsed time in nanoseconds since the last call. On the first call to fire(), returns the elapsed time since the RateProbe was constructed.

rateHzOverNSamples

public RxGetter<Double> rateHzOverNSamples(int n)

Returns the average rate in hertz over the last n samples.

rateHzOver

public RxGetter<Double> rateHzOver(long timespan,
                                   TimeUnit unit)

Returns the average rate in hertz over the specified time period.