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

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() Pauses "asynchronously" whereby the issuing EventHandler can pause without blocking other handlers in the EventLoop.
boolean	asyncPausing() Returns if this Pauser is still asynchronously pausing.
long	countPaused() Returns the number of times the pauser has checked for completion.
void	pause() Pauses the current thread.
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 paused time so far in milliseconds.
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, toString, 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()

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

asyncPause

public void asyncPause()

Description copied from interface: Pauser

Pauses "asynchronously" whereby the issuing EventHandler can pause without blocking other handlers in the EventLoop.

The issuing EventHandler can check if it is still pausing asynchronously by invoking Pauser.asyncPausing(). Typically, this is done as depicted below:

     // @Override
     public boolean action() throws InvalidEventHandlerException {
       if (pauser.asyncPausing()) {
           // Yield, so that other EventHandlers can run
           return false;
       }
     }
 

Specified by:

asyncPause in interface Pauser

See Also:

Pauser.asyncPausing()

asyncPausing

public boolean asyncPausing()

Description copied from interface: Pauser

Returns if this Pauser is still asynchronously pausing.

Specified by:

asyncPausing in interface Pauser

Returns:

if this Pauser is still asynchronously pausing

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

Description copied from interface: Pauser

Returns the paused time so far in milliseconds.

Specified by:

timePaused in interface Pauser

Returns:

the paused time so far in milliseconds

countPaused

public long countPaused()

Description copied from interface: Pauser

Returns the number of times the pauser has checked for completion.

Specified by:

countPaused in interface Pauser

Returns:

Returns the number of times the pauser has checked for completion