net.openhft.chronicle.threads

Enum BusyPauser

java.lang.Object

java.lang.Enum<BusyPauser>

net.openhft.chronicle.threads.BusyPauser

All Implemented Interfaces:

Serializable, Comparable<BusyPauser>, Pauser

public enum BusyPauser
extends Enum<BusyPauser>
implements Pauser

Nested Class Summary

Nested classes/interfaces inherited from interface net.openhft.chronicle.threads.Pauser

Pauser.SleepyWarning

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields inherited from interface net.openhft.chronicle.threads.Pauser

BALANCED, MIN_PROCESSORS, SLEEPY

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	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.
static BusyPauser	valueOf(String name) Returns the enum constant of this type with the specified name.
static BusyPauser[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.threads.Pauser

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

Enum Constant Detail

INSTANCE

public static final BusyPauser INSTANCE

Method Detail

values

public static BusyPauser[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BusyPauser c : BusyPauser.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BusyPauser valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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

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