Package com.yahoo.concurrent

Enum Class SystemTimer

java.lang.Object

java.lang.Enum<SystemTimer>

com.yahoo.concurrent.SystemTimer

All Implemented Interfaces:

Timer, Serializable, Comparable<SystemTimer>, Constable

public enum SystemTimer
extends Enum<SystemTimer>
implements Timer

This is an implementation of Timer that is backed by an actual system timer.

Author:

Simon Thoresen Hult

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields inherited from interface com.yahoo.concurrent.Timer

creationNanos, monotonic

Method Summary

Modifier and Type	Method	Description
static Duration	adjustTimeoutByDetectedHz(Duration timeout)
static Duration	adjustTimeoutByDetectedHz(Duration timeout, long hz)
static long	detectHz()
long	milliTime()	Returns the current value of some arbitrary timer, in milliseconds.
static SystemTimer	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SystemTimer[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.yahoo.concurrent.Timer

instant

Enum Constant Details

INSTANCE

public static final SystemTimer INSTANCE

Method Details

values

public static SystemTimer[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SystemTimer valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

detectHz

public static long detectHz()

adjustTimeoutByDetectedHz

public static Duration adjustTimeoutByDetectedHz(Duration timeout)

adjustTimeoutByDetectedHz

public static Duration adjustTimeoutByDetectedHz(Duration timeout,
 long hz)

milliTime

public long milliTime()

Description copied from interface: Timer

Returns the current value of some arbitrary timer, in milliseconds. This method can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.

Specified by:

milliTime in interface Timer

Returns:

The current value of the timer, in milliseconds.