net.openhft.chronicle.threads

Interface Pauser

All Known Subinterfaces:

TimingPauser

All Known Implementing Classes:

BusyPauser, BusyTimedPauser, LightPauser, LongPauser, MilliPauser, TimeoutPauser, YieldingPauser

public interface Pauser

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Pauser.SleepyWarning

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_PROCESSORS
static boolean	SLEEPY

Method Summary

Modifier and Type	Method and Description
static Pauser	balanced() A balanced pauser which tries to be busy for short bursts but backs off when idle.
static Pauser	balancedUpToMillis(int millis) A balanced pauser which tries to be busy for short bursts but backs off when idle.
static Pauser	busy() A busy pauser which never waits
long	countPaused() Returns the number of times the pauser has checked for completion.
static boolean	getSleepy()
static MilliPauser	millis(int millis) Wait a fixed time before running again unless woken
static Pauser	millis(int minMillis, int maxMillis) A balanced pauser which tries to be busy for short bursts but backs off when idle.
void	pause() Pauses the current thread.
default void	pause(long timeout, TimeUnit timeUnit) use TimingPauser.pause(long, TimeUnit) instead
void	reset() Resets the pauser's internal state back to the most aggressive setting.
static TimingPauser	sleepy()
static TimingPauser	timedBusy()
long	timePaused() Returns the paused time so far in milliseconds.
void	unpause() Try to cancel the pausing if it is pausing.
static Pauser	yielding() Yielding pauser.
static Pauser	yielding(int minBusy)

Field Detail

MIN_PROCESSORS

static final int MIN_PROCESSORS

SLEEPY

static final boolean SLEEPY

Method Detail

reset

void reset()

Resets the pauser's internal state back to the most aggressive setting.

Call this if you just did some work.

pause

void pause()

Pauses the current thread.

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

Call this if no work was done.

pause

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

use TimingPauser.pause(long, TimeUnit) instead

Throws:

TimeoutException

unpause

void unpause()

Try to cancel the pausing if it is pausing.

No guarantee is made as to if unpause will actually have an effect.

timePaused

long timePaused()

Returns the paused time so far in milliseconds.

Returns:

the paused time so far in milliseconds

countPaused

long countPaused()

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

Returns:

Returns the number of times the pauser has checked for completion

getSleepy

static boolean getSleepy()

yielding

static Pauser yielding(int minBusy)

sleepy

static TimingPauser sleepy()

balanced

static Pauser balanced()

A balanced pauser which tries to be busy for short bursts but backs off when idle.

Returns:

a balanced pauser

balancedUpToMillis

static Pauser balancedUpToMillis(int millis)

A balanced pauser which tries to be busy for short bursts but backs off when idle.

Parameters:

millis - maximum millis (unless in debug mode)

Returns:

a balanced pauser

millis

static MilliPauser millis(int millis)

Wait a fixed time before running again unless woken

Parameters:

millis - to wait for

Returns:

a waiting pauser

millis

static Pauser millis(int minMillis,
                     int maxMillis)

A balanced pauser which tries to be busy for short bursts but backs off when idle.

Parameters:

minMillis - starting millis

maxMillis - maximum millis

Returns:

a balanced pauser

yielding

static Pauser yielding()

Yielding pauser. simpler than LongPauser but slightly more friendly to other processes

busy

@NotNull
static Pauser busy()

A busy pauser which never waits

Returns:

a busy/non pauser

timedBusy

@NotNull
static TimingPauser timedBusy()