KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > util > threadpool > ThreadPool


1 /*
2   * JBoss, Home of Professional Open Source
3   * Copyright 2005, JBoss Inc., and individual contributors as indicated
4   * by the @authors tag. See the copyright.txt in the distribution for a
5   * full listing of individual contributors.
6   *
7   * This is free software; you can redistribute it and/or modify it
8   * under the terms of the GNU Lesser General Public License as
9   * published by the Free Software Foundation; either version 2.1 of
10   * the License, or (at your option) any later version.
11   *
12   * This software is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this software; if not, write to the Free
19   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21   */
22 package org.jboss.util.threadpool;
23
24 /**
25  * A thread pool.
26  *
27  * @author <a HREF="mailto:adrian@jboss.org">Adrian Brock</a>
28  * @version $Revision: 1958 $
29  */
30 public interface ThreadPool
31 {
32    // Constants -----------------------------------------------------
33
34    // Public --------------------------------------------------------
35
36    /**
37     * Stop the pool
38     *
39     * @param immediate whether to shutdown immediately
40     */
41    public void stop(boolean immediate);
42
43    /** Wait on the queued tasks to complete. This can only be called after
44     * after stop.
45     *
46     * @throws InterruptedException
47     */
48    public void waitForTasks() throws InterruptedException JavaDoc;
49
50    /** Wait on the queued tasks to complete upto maxWaitTime milliseconds. This
51     * can only be called after after stop.
52     *
53     * @param maxWaitTime
54     * @throws InterruptedException
55     */
56    public void waitForTasks(long maxWaitTime) throws InterruptedException JavaDoc;
57
58    /**
59     * Run a task wrapper
60     *
61     * @param wrapper the task wrapper
62     */
63    public void runTaskWrapper(TaskWrapper wrapper);
64
65    /**
66     * Run a task
67     *
68     * @param task the task
69     * @throws IllegalArgumentException for a null task
70     */
71    public void runTask(Task task);
72
73    /**
74     * Run a runnable
75     *
76     * @param runnable the runnable
77     * @throws IllegalArgumentException for a null runnable
78     */
79    public void run(Runnable JavaDoc runnable);
80
81    /**
82     *
83     * @param runnable
84     * @param startTimeout
85     * @param completeTimeout
86     */
87    public void run(Runnable JavaDoc runnable, long startTimeout, long completeTimeout);
88 }
89
Popular Tags