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 Here is a list of the different Pauser Mode features

Enum Constant Summary

Enum Constants

Enum Constant and Description
balanced Returns Suppliers providing pausers performing busy waiting (spin-wait at 100% CPU) for short periods and then backs off when idle for longer periods, if there are sufficient available processors.
busy Returns Suppliers providing pausers performing busy waiting (spin-wait at 100% CPU) if there are sufficient available processors.
milli Returns Suppliers providing pausers that sleeps for one millisecond when backing off.
sleepy Returns Suppliers providing pausers hat backs off when idle.
timedBusy Returns Suppliers similar to busy but that provides pausers that supports timed pauser.
yielding Returns Suppliers providing pausers that is very briefly busy waiting (spin-wait at 100% CPU) and then yields execution, if there are sufficient available processors.

Method Summary

Modifier and Type	Method and Description
boolean	isolcpus() Returns if provided Pausers supports 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 Suppliers providing pausers performing busy waiting (spin-wait at 100% CPU) for short periods and then backs off when idle for longer periods, if there are sufficient available processors. Otherwise, returns Supplers consistent with sleepy depending on the system property "pauser.minProcessors".

Balanced pausers is trying to balance latency and required CPU resources.

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

See Also:

Runtime.availableProcessors()

busy

public static final PauserMode busy

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

Busy pausers have the lowest latency times but requires the most CPU resources.

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

See Also:

Runtime.availableProcessors()

milli

public static final PauserMode milli

Returns Suppliers providing pausers that sleeps for one millisecond when backing off.

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

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

See Also:

Runtime.availableProcessors()

sleepy

public static final PauserMode sleepy

Returns Suppliers providing pausers hat backs off when idle.

Sleepy pausers have fair latency and requires limited CPU resources.

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

See Also:

Runtime.availableProcessors()

timedBusy

public static final PauserMode timedBusy

Returns Suppliers similar to busy but that provides pausers that supports timed pauser.

See Also:

busy

yielding

public static final PauserMode yielding

Returns Suppliers providing pausers that is very briefly busy waiting (spin-wait at 100% CPU) and then yields execution, if there are sufficient available processors. Otherwise, returns Supplers consistent with balanced or even sleepy depending on the system property "pauser.minProcessors".

Yelding pausers have low latency times but may require significant CPU resources.

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

See Also:

Runtime.availableProcessors()

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 supports CPU isolation.

Returns:

if provided Pausers supports CPU isolation

monitor

public boolean monitor()

Returns if provided Pausers can be monitored.

Returns:

if provided Pausers can be monitored