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

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_PROCESSORS, SLEEPY

Constructor Summary

Constructors

Constructor and Description
MilliPauser(long pauseTimeMS) Pauses for a fixed 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.
MilliPauser	minPauseTimeMS(long pauseTimeMS)
void	pause() Pauses the current thread.
long	pauseTimeMS()
MilliPauser	pauseTimeMS(long pauseTimeMS)
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, millis, millis, pause, sleepy, timedBusy, yielding, yielding

Constructor Detail

MilliPauser

public MilliPauser(long pauseTimeMS)

Pauses for a fixed time

Parameters:

pauseTimeMS - the pause time for each loop.

Method Detail

pauseTimeMS

public MilliPauser pauseTimeMS(long pauseTimeMS)

minPauseTimeMS

public MilliPauser minPauseTimeMS(long pauseTimeMS)

pauseTimeMS

public long pauseTimeMS()

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:

{@code

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

unpause

public void unpause()

Description copied from interface: Pauser

Try to cancel the pausing if it is pausing.

No guarantee is made as to if unpause 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