1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/util/TimeoutController.java,v 1.4 2003/01/31 00:33:37 jsdever Exp $
3 * $Revision: 1.4 $
4 * $Date: 2003/01/31 00:33:37 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient.util;
65
66 /***
67 * <p>
68 * Executes a task with a specified timeout.
69 * </p>
70 * @author Ortwin Gl�ck
71 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
72 * @version $Revision: 1.4 $
73 * @since 2.0
74 */
75
76 public final class TimeoutController {
77
78 /***
79 * Do not instantiate objects of this class. Methods are static.
80 */
81 private TimeoutController() {
82 }
83
84 /***
85 * Executes <code>task</code>. Waits for <code>timeout</code>
86 * milliseconds for the task to end and returns. If the task does not return
87 * in time, the thread is interrupted and an Exception is thrown.
88 * The caller should override the Thread.interrupt() method to something that
89 * quickly makes the thread die or use Thread.isInterrupted().
90 * @param task The thread to execute
91 * @param timeout The timeout in milliseconds. 0 means to wait forever.
92 * @throws TimeoutException if the timeout passes and the thread does not return.
93 */
94 public static void execute(Thread task, long timeout) throws TimeoutException {
95 task.start();
96 try {
97 task.join(timeout);
98 } catch (InterruptedException e) {
99 /* if somebody interrupts us he knows what he is doing */
100 }
101 if (task.isAlive()) {
102 task.interrupt();
103 throw new TimeoutException();
104 }
105 }
106
107 /***
108 * Executes <code>task</code> in a new deamon Thread and waits for the timeout.
109 * @param task The task to execute
110 * @param timeout The timeout in milliseconds. 0 means to wait forever.
111 * @throws TimeoutException if the timeout passes and the thread does not return.
112 */
113 public static void execute(Runnable task, long timeout) throws TimeoutException {
114 Thread t = new Thread(task, "Timeout guard");
115 t.setDaemon(true);
116 execute(t, timeout);
117 }
118
119 /***
120 * Signals that the task timed out.
121 */
122 public static class TimeoutException extends Exception {
123 /*** Create an instance */
124 public TimeoutException() {
125 }
126 }
127 }
This page was automatically generated by Maven