Pauser (OpenHFT/Chronicle-Threads 2.21ea60 API)

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

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Pauser.SleepyWarning`

Field Summary

Fields
Modifier and Type Field and Description

static boolean BALANCED

static int MIN_PROCESSORS

static boolean SLEEPY

Fields
Modifier and Type	Field and Description
`static boolean`	`BALANCED`
`static int`	`MIN_PROCESSORS`
`static boolean`	`SLEEPY`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`asyncPause()` Pauses "asynchronously" whereby the issuing EventHandler can pause without blocking other handlers in the EventLoop.
`default boolean`	`asyncPausing()` Returns if this Pauser is still asynchronously pausing.
`static TimingPauser`	`balanced()` A balanced pauser which tries to be busy for short bursts but backs off when idle.
`static TimingPauser`	`balancedUpToMillis(int millis)` A balanced pauser which tries to be busy for short bursts but backs off when idle.
`static @NotNull Pauser`	`busy()` A busy pauser which never waits
`long`	`countPaused()` Returns the number of times the pauser has checked for completion.
`static boolean`	`getBalanced()`
`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 (if any) to the most aggressive setting.
`static TimingPauser`	`sleepy()`
`static @NotNull 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
```
  - BALANCED
```
static final boolean BALANCED
```
  - SLEEPY
```
static final boolean SLEEPY
```
- Method Detail
  - getBalanced
```
static boolean getBalanced()
```
  - getSleepy
```
static boolean getSleepy()
```
  - yielding
```
static Pauser yielding(int minBusy)
```
  - sleepy
```
static TimingPauser sleepy()
```
  - balanced
```
static TimingPauser balanced()
```
    A balanced pauser which tries to be busy for short bursts but backs off when idle.
    
    Returns:
    
    a balanced pauser
  - balancedUpToMillis
```
static TimingPauser 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 @NotNull Pauser busy()
```
    A busy pauser which never waits
    
    Returns:
    
    a busy/non pauser
  - timedBusy
```
@NotNull
static @NotNull TimingPauser timedBusy()
```
  - pause
```
void pause()
```
    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.
  - asyncPause
```
default void asyncPause()
```
    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 asyncPausing(). Typically this is done as depicted below:
```
{@code
```
    See Also:
    
    asyncPausing()
  - asyncPausing
```
default boolean asyncPausing()
```
    Returns if this Pauser is still asynchronously pausing.
    
    Returns:
    
    if this Pauser is still asynchronously pausing
  - reset
```
void reset()
```
    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.
  - 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

Interface Pauser

Nested Class Summary

Field Summary

Method Summary

Field Detail

MIN_PROCESSORS

BALANCED

SLEEPY

Method Detail

getBalanced

getSleepy

yielding

sleepy

balanced

balancedUpToMillis

millis

millis

yielding

busy

timedBusy

pause

asyncPause

asyncPausing

reset

pause

unpause

timePaused

countPaused