com.peterphi.std.threading

Class Daemon

java.lang.Object

com.peterphi.std.threading.Daemon

All Implemented Interfaces:

java.lang.Runnable

public abstract class Daemon
extends java.lang.Object
implements java.lang.Runnable

Simplifies the creation of long-running daemon threads

Constructor Summary

Constructors

Constructor and Description
Daemon()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	interrupt(boolean waitingHeuristic) Politely asks the daemon to reconsider its termination condition.
boolean	isRunning() Returns whether the daemon is in the process of terminating
boolean	isThreadRunning() Determines if this daemon's thread is alive
protected boolean	shouldStartAsDaemon() Overloading this method to return true will start this daemon's thread as a Daemon Thread
java.lang.Thread	startThread() Starts this daemon, creating a new thread for it (the name of which will be set to the SimpleName of its class)
java.lang.Thread	startThread(java.lang.String name) Starts this daemon, creating a new thread for it
static void	stopAll(java.util.List<? extends Daemon> daemons) Stop all the daemons in a given list:
void	stopThread() Requests the daemon terminate by setting a flag and sending an interrupt to the thread
static boolean	waitForTermination(Daemon daemon, long timeoutMillis)
static boolean	waitForTermination(java.util.List<? extends Daemon> daemons, long timeoutMillis)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

Daemon

public Daemon()

Method Detail

startThread

public java.lang.Thread startThread()
                             throws java.lang.IllegalThreadStateException

Starts this daemon, creating a new thread for it (the name of which will be set to the SimpleName of its class)

Returns:

Thread The daemon's thread

Throws:

java.lang.IllegalThreadStateException - If the daemon is still running

startThread

public java.lang.Thread startThread(java.lang.String name)
                             throws java.lang.IllegalThreadStateException

Starts this daemon, creating a new thread for it

Parameters:

name - String The name for the thread

Returns:

Thread The daemon's thread

Throws:

java.lang.IllegalThreadStateException - If the daemon is still running

isRunning

public boolean isRunning()

Returns whether the daemon is in the process of terminating

Returns:

boolean True if the daemon is terminated or terminating, otherwise false

stopThread

public void stopThread()

Requests the daemon terminate by setting a flag and sending an interrupt to the thread

interrupt

protected void interrupt(boolean waitingHeuristic)

Politely asks the daemon to reconsider its termination condition. The default implementation interrupts the thread.

Parameters:

waitingHeuristic - boolean True if the Daemon thinks this thread's blocked

Since:

standard library 2007-11-26

isThreadRunning

public boolean isThreadRunning()

Determines if this daemon's thread is alive

Returns:

boolean True if the thread is alive, otherwise false

shouldStartAsDaemon

protected boolean shouldStartAsDaemon()

Overloading this method to return true will start this daemon's thread as a Daemon Thread

Returns:

boolean True if the thread should be started as a daemon, otherwise false

stopAll

public static void stopAll(java.util.List<? extends Daemon> daemons)

Stop all the daemons in a given list:

Parameters:

daemons - List[Daemon] The daemons to stop

waitForTermination

public static boolean waitForTermination(Daemon daemon,
                         long timeoutMillis)

waitForTermination

public static boolean waitForTermination(java.util.List<? extends Daemon> daemons,
                         long timeoutMillis)