org.LatencyUtils.IntervalEstimator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of LatencyUtils Show documentation

LatencyUtils is a package that provides latency recording and reporting utilities.

There is a newer version: 2.0.3

/**
 * Written by Gil Tene of Azul Systems, and released to the public domain,
 * as explained at http://creativecommons.org/publicdomain/zero/1.0/
 */

package org.LatencyUtils;

/**
 * IntervalEstimator is used to estimate intervalEndTimes, potentially based on observed intervalEndTimes recorded in it.
 */
public abstract class IntervalEstimator {

    /**
     * Record an interval
     * @param when the end time (in nanoTime units) at which the interval was observed.
     */
    abstract public void recordInterval(long when);

    /**
     * Provides the estimated interval
     *
     * @param when the time (preferably now) at which the estimated interval is requested.
     * @return estimated interval
     */
    abstract public long getEstimatedInterval(long when);
}