net.openhft.chronicle.threads

Class BusyTimedPauser

java.lang.Object

net.openhft.chronicle.threads.BusyTimedPauser

All Implemented Interfaces:

Pauser, TimingPauser

public class BusyTimedPauser
extends Object
implements Pauser, TimingPauser

Similar to BusyPauser but also supporting TimingPauser

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

Method Summary

Modifier and Type	Method and Description
long	countPaused() Returns the count of how many times the pause() method has been called.
boolean	isBusy() Always returns true, indicating that this pauser predominantly keeps the thread busy.
void	pause() Pauses the current thread.
void	pause(long timeout, TimeUnit timeUnit) Attempts to pause the thread with a specified timeout.
void	reset() Resets the pauser's internal state back (if any) to the most aggressive setting.
long	timePaused() Always returns 0 as this pauser does not actually track total pause time.
String	toString() Provides a string representation for this pauser, identifying it as "PauserMode.timedBusy".
void	unpause() Does nothing since this implementation has no state to unpause from.

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, millis, millis, sleepy, timedBusy, yielding, yielding

Constructor Detail

BusyTimedPauser

public BusyTimedPauser()

Method Detail

isBusy

public boolean isBusy()

Always returns true, indicating that this pauser predominantly keeps the thread busy.

Specified by:

isBusy in interface Pauser

Returns:

true, as the primary operation is a busy wait

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

Description copied from interface: Pauser

Pauses the current thread.

The actual pause time and thread scheduling impact is not specified and depends on the implementing class. For some implementations, a progressive increase of the pause time is employed, thread executions may or may not be yielded, whereas other implementations may not pause or yield at all.

Thus, depending on the implementation this could do nothing (busy spin), yield, sleep, ...

Call this if no work was done.

Specified by:

pause in interface Pauser

pause

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

Attempts to pause the thread with a specified timeout. If the pause exceeds the specified duration, a TimeoutException is thrown, indicating the timeout has elapsed without resumption of operations.

Specified by:

pause in interface Pauser

Specified by:

pause in interface TimingPauser

Parameters:

timeout - the maximum time to wait before throwing an exception

timeUnit - the unit of time for the timeout parameter

Throws:

TimeoutException - if the wait exceeds the specified timeout duration

unpause

public void unpause()

Does nothing since this implementation has no state to unpause from. The method exists to fulfill the interface contract.

Specified by:

unpause in interface Pauser

timePaused

public long timePaused()

Always returns 0 as this pauser does not actually track total pause time.

Specified by:

timePaused in interface Pauser

Returns:

0, indicating no measurable pause duration

countPaused

public long countPaused()

Returns the count of how many times the pause() method has been called.

Specified by:

countPaused in interface Pauser

Returns:

the number of pauses that have been initiated

toString

public String toString()

Provides a string representation for this pauser, identifying it as "PauserMode.timedBusy".

Overrides:

toString in class Object

Returns:

a string indicating the type of pauser