net.openhft.chronicle.threads

Class MilliPauser

java.lang.Object

net.openhft.chronicle.threads.MilliPauser

All Implemented Interfaces:

Pauser

public class MilliPauser
extends Object
implements Pauser

A Pauser implementation that provides precise control over thread pausing based on a specified duration in milliseconds. This pauser can operate both synchronously and asynchronously, providing flexibility in thread management.

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
MilliPauser(long pauseTimeMS) Constructs a new MilliPauser with a specified pause time in milliseconds.

Method Summary

Modifier and Type	Method and Description
void	asyncPause() Initiates an asynchronous pause that will last for the previously set pause duration.
boolean	asyncPausing() Checks if the pauser is currently in an asynchronous pausing state.
long	countPaused() Returns the number of times this pauser has been activated to pause the thread.
MilliPauser	minPauseTimeMS(long pauseTimeMS) Sets the pause time to the minimum of the current or specified duration in milliseconds.
void	pause() Pauses the current thread for the configured duration using millisecond precision.
void	pause(long timeout, @NotNull TimeUnit timeUnit) Pauses the current thread for a specified duration in milliseconds.
long	pauseTimeMS() Retrieves the current pause time in milliseconds.
MilliPauser	pauseTimeMS(long pauseTimeMS) Sets the pause time to a specified duration in milliseconds.
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, measured in milliseconds.
String	toString() Provides a string representation of this pauser, identifying the configured pause time.
void	unpause() Unpauses the currently paused thread if it is in a paused state.

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

MilliPauser

public MilliPauser(long pauseTimeMS)

Constructs a new MilliPauser with a specified pause time in milliseconds.

Parameters:

pauseTimeMS - the pause time for each pause operation, in milliseconds

Method Detail

pauseTimeMS

public MilliPauser pauseTimeMS(long pauseTimeMS)

Sets the pause time to a specified duration in milliseconds.

Parameters:

pauseTimeMS - the new pause time in milliseconds

Returns:

this MilliPauser instance for chaining

minPauseTimeMS

public MilliPauser minPauseTimeMS(long pauseTimeMS)

Sets the pause time to the minimum of the current or specified duration in milliseconds. Ensures that the pause time does not drop below 1 millisecond.

Parameters:

pauseTimeMS - the proposed minimum pause time in milliseconds

Returns:

this MilliPauser instance for chaining

pauseTimeMS

public long pauseTimeMS()

Retrieves the current pause time in milliseconds.

Returns:

the pause time in milliseconds

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 for the configured duration using millisecond precision.

Specified by:

pause in interface Pauser

asyncPause

public void asyncPause()

Initiates an asynchronous pause that will last for the previously set pause duration. Does not block the caller but sets the pauser to be in a pausing state.

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

Pauses the current thread for a specified duration in milliseconds.

Specified by:

pause in interface Pauser

Parameters:

timeout - the maximum time to pause in the specified timeUnit

timeUnit - the unit of time for timeout

Throws:

TimeoutException - if the pause operation is not completed within the specified timeout

unpause

public void unpause()

Unpauses the currently paused thread if it is in a paused state.

Specified by:

unpause in interface Pauser

timePaused

public long timePaused()

Returns the total time that the thread has been paused, measured in milliseconds.

Specified by:

timePaused in interface Pauser

Returns:

the total paused time in milliseconds

countPaused

public long countPaused()

Returns the number of times this pauser has been activated to pause the thread.

Specified by:

countPaused in interface Pauser

Returns:

the total count of pauses

toString

public String toString()

Provides a string representation of this pauser, identifying the configured pause time.

Overrides:

toString in class Object

Returns:

a string representation of this MilliPauser