DaemonThread (starrocks-bdb-je 18.3.17 API)

java.lang.Object
- com.sleepycat.je.utilint.DaemonThread

All Implemented Interfaces:

DaemonRunner, Runnable

Direct Known Subclasses:

Checkpointer, FileProcessor, INCompressor, StatCapture
```
public abstract class DaemonThread
extends Object
implements DaemonRunner, Runnable
```
A daemon thread. Also see StoppableThread for an alternative daemon construct.

Field Summary

Fields
Modifier and Type	Field and Description
`protected EnvironmentImpl`	`envImpl`
`protected Logger`	`logger`
`protected String`	`name`
`protected int`	`nWakeupRequests`
`static boolean`	`stifleExceptionChatter`

Constructor Summary

Constructors
Constructor and Description

DaemonThread(long waitTime, String name, EnvironmentImpl envImpl)

Constructors
Constructor and Description
`DaemonThread(long waitTime, String name, EnvironmentImpl envImpl)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkErrorListener(Throwable e)` If Daemon Thread throws errors and exceptions, this function will catch it and throw a EnvironmentFailureException, and fail the test.
`protected Logger`	`createLogger()`
`int`	`getNWakeupRequests()` For unit testing.
`Thread`	`getThread()` For testing.
`protected boolean`	`isPaused()` Returns whether the daemon is currently paused/disabled.
`boolean`	`isRunning()` Returns whether the onWakeup method is currently executing.
`protected boolean`	`isShutdownRequested()` Returns whether shutdown has been requested.
`protected long`	`nDeadlockRetries()` Returns the number of retries to perform when Deadlock Exceptions occur.
`protected abstract void`	`onWakeup()` onWakeup is synchronized to ensure that multiple invocations of the DaemonThread aren't made.
`void`	`requestShutdown()`
`void`	`run()`
`void`	`runOrPause(boolean run)` If run is true, starts the thread if not started or unpauses it if already started; if run is false, pauses the thread if started or does nothing if not started.
`void`	`setWaitTime(long waitTime)`
`void`	`shutdown()` Requests shutdown and calls join() to wait for the thread to stop.
`String`	`toString()`
`void`	`wakeup()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - nWakeupRequests
```
protected int nWakeupRequests
```
  - stifleExceptionChatter
```
public static boolean stifleExceptionChatter
```
  - envImpl
```
protected final EnvironmentImpl envImpl
```
  - logger
```
protected final Logger logger
```
- Constructor Detail
  - DaemonThread
```
public DaemonThread(long waitTime,
                    String name,
                    EnvironmentImpl envImpl)
```
- Method Detail
  - createLogger
```
protected Logger createLogger()
```
  - getThread
```
public Thread getThread()
```
    For testing.
  - runOrPause
```
public void runOrPause(boolean run)
```
    If run is true, starts the thread if not started or unpauses it if already started; if run is false, pauses the thread if started or does nothing if not started. Note that no thread is created unless run is true at some time. That way, threads are conserved in cases where the app wants to run their own threads. This can be important when many JE envs are in the same process, in which case a shared cache is often used.
    
    Specified by:
    
    runOrPause in interface DaemonRunner
  - requestShutdown
```
public void requestShutdown()
```
    Specified by:
    
    requestShutdown in interface DaemonRunner
  - shutdown
```
public void shutdown()
```
    Requests shutdown and calls join() to wait for the thread to stop.
    
    Specified by:
    
    shutdown in interface DaemonRunner
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - wakeup
```
public void wakeup()
```
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - checkErrorListener
```
public boolean checkErrorListener(Throwable e)
```
    If Daemon Thread throws errors and exceptions, this function will catch it and throw a EnvironmentFailureException, and fail the test. Only used during testing.
  - nDeadlockRetries
```
protected long nDeadlockRetries()
```
    Returns the number of retries to perform when Deadlock Exceptions occur.
  - onWakeup
```
protected abstract void onWakeup()
                          throws DatabaseException
```
    onWakeup is synchronized to ensure that multiple invocations of the DaemonThread aren't made.
    
    Throws:
    
    DatabaseException
  - isShutdownRequested
```
protected boolean isShutdownRequested()
```
    Returns whether shutdown has been requested. This method should be used to to terminate daemon loops.
  - isPaused
```
protected boolean isPaused()
```
    Returns whether the daemon is currently paused/disabled. This method should be used to to terminate daemon loops.
  - isRunning
```
public boolean isRunning()
```
    Returns whether the onWakeup method is currently executing. This is only an approximation and is used to avoid unnecessary wakeups.
  - setWaitTime
```
public void setWaitTime(long waitTime)
```
  - getNWakeupRequests
```
public int getNWakeupRequests()
```
    For unit testing.
    
    Specified by:
    
    getNWakeupRequests in interface DaemonRunner

Class DaemonThread

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

nWakeupRequests

stifleExceptionChatter

envImpl

logger

Constructor Detail

DaemonThread

Method Detail

createLogger

getThread

runOrPause

requestShutdown

shutdown

toString

wakeup

run

checkErrorListener

nDeadlockRetries

onWakeup

isShutdownRequested

isPaused

isRunning

setWaitTime

getNWakeupRequests