net.openhft.chronicle.threads

Class TimeoutPauser

java.lang.Object

net.openhft.chronicle.threads.TimeoutPauser

All Implemented Interfaces:

Pauser, TimingPauser

public class TimeoutPauser
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_PROCESSORS, SLEEPY

Constructor Summary

Constructors

Constructor and Description
TimeoutPauser(int minBusy) first it will busy wait, then it will yield.

Method Summary

Modifier and Type	Method and Description
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) use TimingPauser.pause(long, TimeUnit) instead
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

asyncPause, asyncPausing, balanced, balancedUpToMillis, busy, getBalanced, getSleepy, millis, millis, sleepy, timedBusy, yielding, yielding

Constructor Detail

TimeoutPauser

public TimeoutPauser(int minBusy)

first it will busy wait, then it will yield.

Parameters:

minBusy - the min number of times it will go around doing nothing, after this is reached it will then start to yield

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

pause

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

Description copied from interface: Pauser

use TimingPauser.pause(long, TimeUnit) instead

Specified by:

pause in interface Pauser

Specified by:

pause in interface TimingPauser

Parameters:

timeout - timeout

timeUnit - unit

Throws:

TimeoutException - thrown if timeout passes

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