net.openhft.chronicle.threads

Enum PauserMode

java.lang.Object

java.lang.Enum<PauserMode>

net.openhft.chronicle.threads.PauserMode

All Implemented Interfaces:

Serializable, Comparable<PauserMode>, Supplier<Pauser>

public enum PauserMode
extends Enum<PauserMode>
implements Supplier<Pauser>

This class contains factory methods for Pausers. Because Pauser is not an enum, and implementations are not Marshallable, this makes Pausers more yaml friendly

The various Pauser modes and their properties can be seen here: Pauser Mode features

Enum Constant Summary

Enum Constants

Enum Constant and Description
balanced Returns a Supplier providing pausers that will busy wait (spin-wait at 100% CPU) for short periods and then backs off when idle for longer periods.
busy Returns a Supplier providing pausers this will busy wait (spin-wait at 100% CPU) if there are sufficient available processors.
milli Returns a Supplier providing pausers that sleeps for one millisecond with no back off.
sleepy Returns a Supplier providing back off pausers that are less aggressive than balanced.
timedBusy Returns a Supplier similar to busy but that provides pausers that supports TimingPauser.
yielding Returns a Supplier providing pausers that yields execution (see Thread.yield(), if there are sufficient available processors.

Method Summary

Modifier and Type	Method and Description
boolean	isolcpus() Returns if provided Pausers requires CPU isolation.
boolean	monitor() Returns if provided Pausers can be monitored.
static PauserMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static PauserMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, 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 java.util.function.Supplier

get

Enum Constant Detail

balanced

public static final PauserMode balanced

Returns a Supplier providing pausers that will busy wait (spin-wait at 100% CPU) for short periods and then backs off when idle for longer periods. If there are not sufficient available processors, returns sleepy depending on the system property "pauser.minProcessors".

See Pauser.balanced()

See Also:

Runtime.availableProcessors()

busy

public static final PauserMode busy

Returns a Supplier providing pausers this will busy wait (spin-wait at 100% CPU) if there are sufficient available processors. Otherwise, returns Supplier consistent with balanced or even sleepy depending on the system property "pauser.minProcessors".

See Pauser.busy()

See Also:

Runtime.availableProcessors()

milli

public static final PauserMode milli

Returns a Supplier providing pausers that sleeps for one millisecond with no back off.

Milli pausers have long latency times but require minimum CPU resources.

See Pauser.millis(int)

sleepy

public static final PauserMode sleepy

Returns a Supplier providing back off pausers that are less aggressive than balanced.

Sleepy pausers have relatively high latency but require limited CPU resources.

See Pauser.sleepy()

timedBusy

public static final PauserMode timedBusy

Returns a Supplier similar to busy but that provides pausers that supports TimingPauser.

See Pauser.timedBusy()

yielding

public static final PauserMode yielding

Returns a Supplier providing pausers that yields execution (see Thread.yield(), if there are sufficient available processors. Otherwise, returns a Supplier consistent with balanced or even sleepy depending on the system property "pauser.minProcessors".

See Pauser.yielding()

Method Detail

values

public static PauserMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PauserMode c : PauserMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static PauserMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

isolcpus

public boolean isolcpus()

Returns if provided Pausers requires CPU isolation.

Returns:

if provided Pausers requires CPU isolation

monitor

public boolean monitor()

Returns if provided Pausers can be monitored.

Returns:

if provided Pausers can be monitored