net.openhft.chronicle.threads

Class YieldingPauser

java.lang.Object

net.openhft.chronicle.threads.YieldingPauser

All Implemented Interfaces:

Pauser, TimingPauser

Direct Known Subclasses:

TimeoutPauser

public class YieldingPauser
extends Object
implements TimingPauser

This pauser is designed for situations where short bursts of busyness are acceptable before yielding, aiming to balance responsiveness with CPU usage. The transition from busy-waiting to yielding helps to manage CPU resources more effectively while still allowing the thread to remain responsive.

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.threads.Pauser

Pauser.SleepyWarning

Field Summary

Fields inherited from interface net.openhft.chronicle.threads.Pauser

BALANCED, MIN_BUSY, MIN_PROCESSORS, SLEEPY

Constructor Summary

Constructors

Constructor and Description
YieldingPauser(int minBusy) Constructs a YieldingPauser with a specified threshold for busy waiting.

Method Summary

Modifier and Type	Method and Description
long	countPaused() Returns the number of times this pauser has been activated, including both busy-wait and yield iterations.
void	pause() Pauses the thread by either busy-waiting or yielding, depending on the number of iterations specified by minBusy.
void	pause(long timeout, @NotNull TimeUnit timeUnit) Pauses the thread with a timeout.
void	reset() Resets the pauser's internal state back (if any) to the most aggressive setting.
long	timePaused() Returns the total time this pauser has spent yielding, measured in milliseconds.
String	toString() Provides a string representation of this pauser, which varies based on the minBusy configuration.
void	unpause() Try to cancel the pausing if it is pausing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.threads.Pauser

asyncPause, asyncPausing, balanced, balancedUpToMillis, busy, getBalanced, getSleepy, isBusy, millis, millis, sleepy, timedBusy, yielding, yielding

Constructor Detail

YieldingPauser

public YieldingPauser(int minBusy)

Constructs a YieldingPauser with a specified threshold for busy waiting.

Parameters:

minBusy - the minimum number of iterations to perform busy waiting before yielding

Method Detail

reset

public void reset()

Description copied from interface: Pauser

Resets the pauser's internal state back (if any) to the most aggressive setting.

Pausers that progressively increases the pause time are reset back to its lowest pause time.

Call this if you just did some work.

Specified by:

reset in interface Pauser

pause

public void pause()

Pauses the thread by either busy-waiting or yielding, depending on the number of iterations specified by minBusy. Initially, it will busy-wait up to minBusy iterations; thereafter, it will yield to other threads.

Specified by:

pause in interface Pauser

pause

public void pause(long timeout,
                  @NotNull
                  @NotNull TimeUnit timeUnit)
           throws TimeoutException

Pauses the thread with a timeout. The pause may end either after busy-waiting and yielding or when the timeout expires, whichever comes first.

Specified by:

pause in interface Pauser

Specified by:

pause in interface TimingPauser

Parameters:

timeout - the maximum time to wait before throwing a TimeoutException

timeUnit - the unit of time for the timeout argument

Throws:

TimeoutException - if the pause operation exceeds the specified timeout

unpause

public void unpause()

Description copied from interface: Pauser

Try to cancel the pausing if it is pausing.

No guarantee is made that this call will actually have an effect.

Specified by:

unpause in interface Pauser

timePaused

public long timePaused()

Returns the total time this pauser has spent yielding, measured in milliseconds.

Specified by:

timePaused in interface Pauser

Returns:

total yielding time in milliseconds

countPaused

public long countPaused()

Returns the number of times this pauser has been activated, including both busy-wait and yield iterations.

Specified by:

countPaused in interface Pauser

Returns:

the total number of pause activations

toString

public String toString()

Provides a string representation of this pauser, which varies based on the minBusy configuration.

Overrides:

toString in class Object

Returns:

a string representation identifying the mode and settings of this pauser