com.github.javaclub.toolbox.thread.TimeoutThreadExecutor Maven / Gradle / Ivy
/*
* @(#)TimeoutThreadExecutor.java 2012-2-20
*
* Copyright (c) 2012. All Rights Reserved.
*
*/
package com.github.javaclub.toolbox.thread;
import com.github.javaclub.toolbox.TimeoutException;
/**
* TimeoutThreadExecutor
*
* @author Gerald Chen
* @version $Id: TimeoutThreadExecutor.java 1546 2012-02-20 14:22:53Z [email protected] $
*/
public final class TimeoutThreadExecutor {
/**
* Do not instantiate objects of this class. Methods are static.
*/
private TimeoutThreadExecutor() {
}
/**
* Executes task. Waits for timeout
* milliseconds for the task to end and returns. If the task does not return
* in time, the thread is interrupted and an Exception is thrown.
* The caller should override the Thread.interrupt() method to something that
* quickly makes the thread die or use Thread.isInterrupted().
* @param task The thread to execute
* @param timeout The timeout in milliseconds. 0 means to wait forever.
* @throws TimeoutException if the timeout passes and the thread does not return.
*/
public static void execute(Thread task, long timeout) throws TimeoutException {
task.start();
try {
task.join(timeout);
} catch (InterruptedException e) {
/* if somebody interrupts us he knows what he is doing */
}
if (task.isAlive()) {
task.interrupt();
throw new TimeoutException();
}
}
/**
* Executes task in a new deamon Thread and waits for the timeout.
* @param task The task to execute
* @param timeout The timeout in milliseconds. 0 means to wait forever.
* @throws TimeoutException if the timeout passes and the thread does not return.
*/
public static void execute(Runnable task, long timeout) throws TimeoutException {
Thread t = new Thread(task, "Timeout guard");
t.setDaemon(true);
execute(t, timeout);
}
}