net.openhft.chronicle.threads

Class LongPauser

java.lang.Object

net.openhft.chronicle.threads.LongPauser

All Implemented Interfaces:

Pauser, TimingPauser

public class LongPauser
extends Object
implements Pauser, TimingPauser

A Pauser that implements a pausing strategy with phases of busy waiting, yielding, and sleeping, with each phase increasing in duration up to a configured limit. It is designed for scenarios where a gradual back-off is needed from active to more passive waiting states.

The pausing behavior begins with busy waiting, transitions to yielding, and ultimately moves to sleeping, progressively increasing the pause time from a minimum to a specified maximum duration.

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
LongPauser(int minBusy, int minYield, long minTime, long maxTime, @NotNull TimeUnit timeUnit) first it will busy wait, then it will yield, then sleep for a small amount of time, then increases to a large amount of time.

Method Summary

Modifier and Type	Method and Description
void	asyncPause() Initiates an asynchronous pause that will last for the current phase's duration.
boolean	asyncPausing() Checks if the pauser is currently in an asynchronous pausing state.
long	countPaused() Returns the total number of pauses that have been initiated.
void	pause() Pauses the current thread according to the phased pausing strategy.
void	pause(long timeout, @NotNull TimeUnit timeUnit) Implementation of the pause method for the LongPauser.
void	reset() Resets the pauser's internal state back (if any) to the most aggressive setting.
long	timePaused() Returns the total time that the thread has been paused, in milliseconds.
String	toString() Provides a human-readable description of the pauser's 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

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

Constructor Detail

LongPauser

public LongPauser(int minBusy,
                  int minYield,
                  long minTime,
                  long maxTime,
                  @NotNull
                  @NotNull TimeUnit timeUnit)

first it will busy wait, then it will yield, then sleep for a small amount of time, then increases to a large amount of time.

Parameters:

minBusy - the length in timeUnit to go around doing nothing, after this is reached it will then start to yield

minYield - the length in timeUnit it will yield, before it starts to sleep

minTime - the amount of time to sleep ( initially )

maxTime - the amount of time subsequently to sleep

timeUnit - the unit of the minTime and maxTime

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 current thread according to the phased pausing strategy.

Specified by:

pause in interface Pauser

asyncPause

public void asyncPause()

Initiates an asynchronous pause that will last for the current phase's duration.

Specified by:

asyncPause in interface Pauser

See Also:

Pauser.asyncPausing()

asyncPausing

public boolean asyncPausing()

Checks if the pauser is currently in an asynchronous pausing state.

Specified by:

asyncPausing in interface Pauser

Returns:

true if still in the pausing state, false otherwise

pause

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

Implementation of the pause method for the LongPauser. This method introduces pauses of increasing duration up to a specified timeout. If the timeout is exceeded, a TimeoutException is thrown.

Specified by:

pause in interface Pauser

Specified by:

pause in interface TimingPauser

Parameters:

timeout - The maximum time duration to wait before throwing a TimeoutException.

timeUnit - The unit of the timeout parameter.

Throws:

TimeoutException - If the pause 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 that the thread has been paused, in milliseconds.

Specified by:

timePaused in interface Pauser

Returns:

total paused time in milliseconds.

countPaused

public long countPaused()

Returns the total number of pauses that have been initiated.

Specified by:

countPaused in interface Pauser

Returns:

the total count of pauses.

toString

public String toString()

Provides a human-readable description of the pauser's configuration.

Overrides:

toString in class Object

Returns:

a string representing the configured pause strategy.