se.l4.vibe.probes.SampledProbe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vibe-api Show documentation

There is a newer version: 0.4.0

package se.l4.vibe.probes;

/**
 * Probe that measures a value that is sampled at certain intervals. A call
 * to a {@link #read()} on a sampled probe should return the last value
 * returned by {@link #sample()}.
 * 
 * @author Andreas Holstenson
 *
 * @param 
 */
public interface SampledProbe
	extends Probe
{
	/**
	 * Check what the current value is.
	 * 
	 * @return
	 */
	T peek();
	
	/**
	 * Sample the current value and optionally reset the probe.
	 * 
	 * @return
	 */
	T sample();
}