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>

Provides factory methods for creating various types of Pauser objects. This enum facilitates the creation of different pausing strategies that control thread execution based on CPU availability and desired pausing characteristics.

Because Pauser is not an enum, and implementations are not Marshallable, using this enum helps in making configurations more YAML-friendly.

For detailed descriptions of the different Pauser modes and their specific properties, see: Pauser Mode features

Enum Constant Summary

Enum Constants

Enum Constant and Description
balanced Provides a Pauser that busy-waits (spins at 100% CPU) for short durations 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 Provides a Pauser that sleeps for one millisecond consistently, without any backing off.
sleepy Provides a Pauser that is less aggressive than balanced, using sleep intervals to conserve CPU resources.
timedBusy Similar to busy but provides a Pauser supporting timed waits.
yielding Provides a Pauser that yields thread execution if there are sufficient processors, otherwise it falls back to balanced or sleepy depending on the system property "pauser.minProcessors".

Method Summary

Modifier and Type	Method and Description
boolean	isolcpus() Indicates whether the provided Pauser is suitable for CPU isolation.
boolean	monitor() Indicates whether the provided Pauser 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

Provides a Pauser that busy-waits (spins at 100% CPU) for short durations 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".

This strategy is ideal for balancing responsiveness with CPU consumption.

See Also:

Pauser.balanced(), 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".

This pauser is designed for scenarios requiring high responsiveness at the cost of higher CPU usage.

See Also:

Pauser.busy(), Runtime.availableProcessors()

milli

public static final PauserMode milli

Provides a Pauser that sleeps for one millisecond consistently, without any backing off.

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

See Also:

Pauser.millis(int)

sleepy

public static final PauserMode sleepy

Provides a Pauser that is less aggressive than balanced, using sleep intervals to conserve CPU resources.

Suitable for lower-priority tasks where response time is less critical.

See Also:

Pauser.sleepy()

timedBusy

public static final PauserMode timedBusy

Similar to busy but provides a Pauser supporting timed waits.

This pauser combines busy-waiting with timed pauses to optimize CPU usage during variable workload conditions.

See Also:

Pauser.timedBusy()

yielding

public static final PauserMode yielding

Provides a Pauser that yields thread execution if there are sufficient processors, otherwise it falls back to balanced or sleepy depending on the system property "pauser.minProcessors".

It is designed to maintain responsiveness without consuming excessive CPU resources in systems with sufficient processing power.

See Also:

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()

Indicates whether the provided Pauser is suitable for CPU isolation.

Returns:

true if CPU isolation is suitable, otherwise false

monitor

public boolean monitor()

Indicates whether the provided Pauser can be monitored.

Returns:

true if the pauser can be monitored, otherwise false