Package org.apache.commons.io
Class ThreadMonitor
- java.lang.Object
-
- org.apache.commons.io.ThreadMonitor
-
- All Implemented Interfaces:
java.lang.Runnable
class ThreadMonitor extends java.lang.Object implements java.lang.Runnable
Monitors a thread, interrupting it if it reaches the specified timeout.This works by sleeping until the specified timeout amount and then interrupting the thread being monitored. If the thread being monitored completes its work before being interrupted, it should
interrupt()
the monitor thread.long timeoutInMillis = 1000; try { Thread monitor = ThreadMonitor.start(timeoutInMillis); // do some work here ThreadMonitor.stop(monitor); } catch (InterruptedException e) { // timed amount was reached }
-
-
Constructor Summary
Constructors Modifier Constructor Description private
ThreadMonitor(java.lang.Thread thread, java.time.Duration timeout)
Constructs a new monitor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
run()
Sleep until the specified timeout amount and then interrupt the thread being monitored.private static void
sleep(java.time.Duration duration)
Sleeps for a guaranteed minimum duration unless interrupted.(package private) static java.lang.Thread
start(java.lang.Thread thread, java.time.Duration timeout)
Start monitoring the specified thread.(package private) static java.lang.Thread
start(java.time.Duration timeout)
Start monitoring the current thread.(package private) static void
stop(java.lang.Thread thread)
Stop monitoring the specified thread.
-
-
-
Method Detail
-
start
static java.lang.Thread start(java.time.Duration timeout)
Start monitoring the current thread.- Parameters:
timeout
- The timeout amount in milliseconds or no timeout if the value is zero or less- Returns:
- The monitor thread or
null
if the timeout amount is not greater than zero
-
start
static java.lang.Thread start(java.lang.Thread thread, java.time.Duration timeout)
Start monitoring the specified thread.- Parameters:
thread
- The thread The thread to monitortimeout
- The timeout amount in milliseconds or no timeout if the value is zero or less- Returns:
- The monitor thread or
null
if the timeout amount is not greater than zero
-
stop
static void stop(java.lang.Thread thread)
Stop monitoring the specified thread.- Parameters:
thread
- The monitor thread, may benull
-
run
public void run()
Sleep until the specified timeout amount and then interrupt the thread being monitored.- Specified by:
run
in interfacejava.lang.Runnable
- See Also:
Runnable.run()
-
sleep
private static void sleep(java.time.Duration duration) throws java.lang.InterruptedException
Sleeps for a guaranteed minimum duration unless interrupted. This method exists because Thread.sleep(100) can sleep for 0, 70, 100 or 200ms or anything else it deems appropriate. Read the docs on Thread.sleep for further interesting details.- Parameters:
duration
- the sleep duration.- Throws:
java.lang.InterruptedException
- if interrupted
-
-