blitz_stable: src/EDU/oswego/cs/dl/util/concurrent/PooledExecutor.java annotate

annotate src/EDU/oswego/cs/dl/util/concurrent/PooledExecutor.java @ 27:511648fa4d64 Version 2.1

Version to 2.1

author	Dan Creswell <dan.creswell@gmail.com>
date	Mon, 04 Jan 2010 13:00:40 +0000
parents	3dc0c5604566
children

rev	line source
0 3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	1 /*
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	2 File: PooledExecutor.java
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	3
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	4 Originally written by Doug Lea and released into the public domain.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	5 This may be used for any purposes whatsoever without acknowledgment.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	6 Thanks for the assistance and support of Sun Microsystems Labs,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	7 and everyone contributing, testing, and using this code.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	8
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	9 History:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	10 Date Who What
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	11 19Jun1998 dl Create public version
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	12 29aug1998 dl rely on ThreadFactoryUser,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	13 remove ThreadGroup-based methods
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	14 adjusted locking policies
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	15 3mar1999 dl Worker threads sense decreases in pool size
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	16 31mar1999 dl Allow supplied channel in constructor;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	17 add methods createThreads, drain
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	18 15may1999 dl Allow infinite keepalives
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	19 21oct1999 dl add minimumPoolSize methods
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	20 7sep2000 dl BlockedExecutionHandler now an interface,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	21 new DiscardOldestWhenBlocked policy
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	22 12oct2000 dl add shutdownAfterProcessingCurrentlyQueuedTasks
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	23 13nov2000 dl null out task ref after run
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	24 08apr2001 dl declare inner class ctor protected
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	25 12nov2001 dl Better shutdown support
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	26 Blocked exec handlers can throw IE
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	27 Simplify locking scheme
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	28 25jan2001 dl {get,set}BlockedExecutionHandler now public
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	29 17may2002 dl null out task var in worker run to enable GC.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	30 */
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	31
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	32 package EDU.oswego.cs.dl.util.concurrent;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	33 import java.util.*;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	34
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	35 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	36 * A tunable, extensible thread pool class. The main supported public
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	37 * method is <code>execute(Runnable command)</code>, which can be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	38 * called instead of directly creating threads to execute commands.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	39 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	40 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	41 * Thread pools can be useful for several, usually intertwined
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	42 * reasons:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	43 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	44 * <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	45 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	46 * <li> To bound resource use. A limit can be placed on the maximum
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	47 * number of simultaneously executing threads.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	48 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	49 * <li> To manage concurrency levels. A targeted number of threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	50 * can be allowed to execute simultaneously.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	51 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	52 * <li> To manage a set of threads performing related tasks.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	53 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	54 * <li> To minimize overhead, by reusing previously constructed
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	55 * Thread objects rather than creating new ones. (Note however
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	56 * that pools are hardly ever cure-alls for performance problems
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	57 * associated with thread construction, especially on JVMs that
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	58 * themselves internally pool or recycle threads.)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	59 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	60 * </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	61 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	62 * These goals introduce a number of policy parameters that are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	63 * encapsulated in this class. All of these parameters have defaults
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	64 * and are tunable, either via get/set methods, or, in cases where
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	65 * decisions should hold across lifetimes, via methods that can be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	66 * easily overridden in subclasses. The main, most commonly set
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	67 * parameters can be established in constructors. Policy choices
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	68 * across these dimensions can and do interact. Be careful, and
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	69 * please read this documentation completely before using! See also
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	70 * the usage examples below.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	71 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	72 * <dl>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	73 * <dt> Queueing
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	74 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	75 * <dd> By default, this pool uses queueless synchronous channels to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	76 * to hand off work to threads. This is a safe, conservative policy
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	77 * that avoids lockups when handling sets of requests that might
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	78 * have internal dependencies. (In these cases, queuing one task
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	79 * could lock up another that would be able to continue if the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	80 * queued task were to run.) If you are sure that this cannot
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	81 * happen, then you can instead supply a queue of some sort (for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	82 * example, a BoundedBuffer or LinkedQueue) in the constructor.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	83 * This will cause new commands to be queued in cases where all
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	84 * MaximumPoolSize threads are busy. Queues are sometimes
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	85 * appropriate when each task is completely independent of others,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	86 * so tasks cannot affect each others execution. For example, in an
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	87 * http server. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	88 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	89 * When given a choice, this pool always prefers adding a new thread
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	90 * rather than queueing if there are currently fewer than the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	91 * current getMinimumPoolSize threads running, but otherwise always
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	92 * prefers queuing a request rather than adding a new thread. Thus,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	93 * if you use an unbounded buffer, you will never have more than
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	94 * getMinimumPoolSize threads running. (Since the default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	95 * minimumPoolSize is one, you will probably want to explicitly
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	96 * setMinimumPoolSize.) <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	97 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	98 * While queuing can be useful in smoothing out transient bursts of
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	99 * requests, especially in socket-based services, it is not very
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	100 * well behaved when commands continue to arrive on average faster
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	101 * than they can be processed. Using bounds for both the queue and
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	102 * the pool size, along with run-when-blocked policy is often a
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	103 * reasonable response to such possibilities. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	104 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	105 * Queue sizes and maximum pool sizes can often be traded off for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	106 * each other. Using large queues and small pools minimizes CPU
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	107 * usage, OS resources, and context-switching overhead, but can lead
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	108 * to artifically low throughput. Especially if tasks frequently
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	109 * block (for example if they are I/O bound), a JVM and underlying
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	110 * OS may be able to schedule time for more threads than you
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	111 * otherwise allow. Use of small queues or queueless handoffs
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	112 * generally requires larger pool sizes, which keeps CPUs busier but
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	113 * may encounter unacceptable scheduling overhead, which also
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	114 * decreases throughput. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	115 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	116 * <dt> Maximum Pool size
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	117 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	118 * <dd> The maximum number of threads to use, when needed. The pool
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	119 * does not by default preallocate threads. Instead, a thread is
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	120 * created, if necessary and if there are fewer than the maximum,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	121 * only when an <code>execute</code> request arrives. The default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	122 * value is (for all practical purposes) infinite --
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	123 * <code>Integer.MAX_VALUE</code>, so should be set in the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	124 * constructor or the set method unless you are just using the pool
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	125 * to minimize construction overhead. Because task handoffs to idle
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	126 * worker threads require synchronization that in turn relies on JVM
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	127 * scheduling policies to ensure progress, it is possible that a new
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	128 * thread will be created even though an existing worker thread has
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	129 * just become idle but has not progressed to the point at which it
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	130 * can accept a new task. This phenomenon tends to occur on some
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	131 * JVMs when bursts of short tasks are executed. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	132 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	133 * <dt> Minimum Pool size
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	134 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	135 * <dd> The minimum number of threads to use, when needed (default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	136 * 1). When a new request is received, and fewer than the minimum
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	137 * number of threads are running, a new thread is always created to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	138 * handle the request even if other worker threads are idly waiting
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	139 * for work. Otherwise, a new thread is created only if there are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	140 * fewer than the maximum and the request cannot immediately be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	141 * queued. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	142 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	143 * <dt> Preallocation
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	144 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	145 * <dd> You can override lazy thread construction policies via
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	146 * method createThreads, which establishes a given number of warm
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	147 * threads. Be aware that these preallocated threads will time out
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	148 * and die (and later be replaced with others if needed) if not used
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	149 * within the keep-alive time window. If you use preallocation, you
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	150 * probably want to increase the keepalive time. The difference
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	151 * between setMinimumPoolSize and createThreads is that
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	152 * createThreads immediately establishes threads, while setting the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	153 * minimum pool size waits until requests arrive. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	154 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	155 * <dt> Keep-alive time
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	156 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	157 * <dd> If the pool maintained references to a fixed set of threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	158 * in the pool, then it would impede garbage collection of otherwise
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	159 * idle threads. This would defeat the resource-management aspects
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	160 * of pools. One solution would be to use weak references. However,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	161 * this would impose costly and difficult synchronization issues.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	162 * Instead, threads are simply allowed to terminate and thus be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	163 * GCable if they have been idle for the given keep-alive time. The
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	164 * value of this parameter represents a trade-off between GCability
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	165 * and construction time. In most current Java VMs, thread
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	166 * construction and cleanup overhead is on the order of
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	167 * milliseconds. The default keep-alive value is one minute, which
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	168 * means that the time needed to construct and then GC a thread is
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	169 * expended at most once per minute.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	170 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	171 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	172 * To establish worker threads permanently, use a <em>negative</em>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	173 * argument to setKeepAliveTime. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	174 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	175 * <dt> Blocked execution policy
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	176 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	177 * <dd> If the maximum pool size or queue size is bounded, then it
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	178 * is possible for incoming <code>execute</code> requests to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	179 * block. There are four supported policies for handling this
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	180 * problem, and mechanics (based on the Strategy Object pattern) to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	181 * allow others in subclasses: <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	182 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	183 * <dl>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	184 * <dt> Run (the default)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	185 * <dd> The thread making the <code>execute</code> request
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	186 * runs the task itself. This policy helps guard against lockup.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	187 * <dt> Wait
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	188 * <dd> Wait until a thread becomes available.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	189 * <dt> Abort
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	190 * <dd> Throw a RuntimeException
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	191 * <dt> Discard
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	192 * <dd> Throw away the current request and return.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	193 * <dt> DiscardOldest
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	194 * <dd> Throw away the oldest request and return.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	195 * </dl>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	196 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	197 * Other plausible policies include raising the maximum pool size
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	198 * after checking with some other objects that this is OK. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	199 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	200 * These cases can never occur if the maximum pool size is unbounded
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	201 * or the queue is unbounded. In these cases you instead face
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	202 * potential resource exhaustion.) The execute method does not
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	203 * throw any checked exceptions in any of these cases since any
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	204 * errors associated with them must normally be dealt with via
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	205 * handlers or callbacks. (Although in some cases, these might be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	206 * associated with throwing unchecked exceptions.) You may wish to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	207 * add special implementations even if you choose one of the listed
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	208 * policies. For example, the supplied Discard policy does not
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	209 * inform the caller of the drop. You could add your own version
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	210 * that does so. Since choice of policies is normally a system-wide
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	211 * decision, selecting a policy affects all calls to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	212 * <code>execute</code>. If for some reason you would instead like
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	213 * to make per-call decisions, you could add variant versions of the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	214 * <code>execute</code> method (for example,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	215 * <code>executeIfWouldNotBlock</code>) in subclasses. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	216 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	217 * <dt> Thread construction parameters
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	218 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	219 * <dd> A settable ThreadFactory establishes each new thread. By
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	220 * default, it merely generates a new instance of class Thread, but
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	221 * can be changed to use a Thread subclass, to set priorities,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	222 * ThreadLocals, etc. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	223 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	224 * <dt> Interruption policy
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	225 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	226 * <dd> Worker threads check for interruption after processing each
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	227 * command, and terminate upon interruption. Fresh threads will
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	228 * replace them if needed. Thus, new tasks will not start out in an
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	229 * interrupted state due to an uncleared interruption in a previous
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	230 * task. Also, unprocessed commands are never dropped upon
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	231 * interruption. It would conceptually suffice simply to clear
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	232 * interruption between tasks, but implementation characteristics of
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	233 * interruption-based methods are uncertain enough to warrant this
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	234 * conservative strategy. It is a good idea to be equally
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	235 * conservative in your code for the tasks running within pools.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	236 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	237 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	238 * <dt> Shutdown policy
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	239 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	240 * <dd> The interruptAll method interrupts, but does not disable the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	241 * pool. Two different shutdown methods are supported for use when
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	242 * you do want to (permanently) stop processing tasks. Method
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	243 * shutdownAfterProcessingCurrentlyQueuedTasks waits until all
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	244 * current tasks are finished. The shutDownNow method interrupts
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	245 * current threads and leaves other queued requests unprocessed.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	246 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	247 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	248 * <dt> Handling requests after shutdown
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	249 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	250 * <dd> When the pool is shutdown, new incoming requests are handled
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	251 * by the blockedExecutionHandler. By default, the handler is set to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	252 * discard new requests, but this can be set with an optional
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	253 * argument to method
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	254 * shutdownAfterProcessingCurrentlyQueuedTasks. <p> Also, if you are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	255 * using some form of queuing, you may wish to call method drain()
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	256 * to remove (and return) unprocessed commands from the queue after
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	257 * shutting down the pool and its clients. If you need to be sure
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	258 * these commands are processed, you can then run() each of the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	259 * commands in the list returned by drain().
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	260 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	261 * </dl>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	262 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	263 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	264 * <b>Usage examples.</b>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	265 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	266 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	267 * Probably the most common use of pools is in statics or singletons
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	268 * accessible from a number of classes in a package; for example:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	269 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	270 * <pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	271 * class MyPool {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	272 * // initialize to use a maximum of 8 threads.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	273 * static PooledExecutor pool = new PooledExecutor(8);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	274 * }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	275 * </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	276 * Here are some sample variants in initialization:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	277 * <ol>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	278 * <li> Using a bounded buffer of 10 tasks, at least 4 threads (started only
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	279 * when needed due to incoming requests), but allowing
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	280 * up to 100 threads if the buffer gets full.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	281 * <pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	282 * pool = new PooledExecutor(new BoundedBuffer(10), 100);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	283 * pool.setMinimumPoolSize(4);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	284 * </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	285 * <li> Same as (1), except pre-start 9 threads, allowing them to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	286 * die if they are not used for five minutes.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	287 * <pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	288 * pool = new PooledExecutor(new BoundedBuffer(10), 100);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	289 * pool.setMinimumPoolSize(4);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	290 * pool.setKeepAliveTime(1000 * 60 * 5);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	291 * pool.createThreads(9);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	292 * </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	293 * <li> Same as (2) except clients block if both the buffer is full and
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	294 * all 100 threads are busy:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	295 * <pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	296 * pool = new PooledExecutor(new BoundedBuffer(10), 100);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	297 * pool.setMinimumPoolSize(4);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	298 * pool.setKeepAliveTime(1000 * 60 * 5);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	299 * pool.waitWhenBlocked();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	300 * pool.createThreads(9);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	301 * </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	302 * <li> An unbounded queue serviced by exactly 5 threads:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	303 * <pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	304 * pool = new PooledExecutor(new LinkedQueue());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	305 * pool.setKeepAliveTime(-1); // live forever
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	306 * pool.createThreads(5);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	307 * </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	308 * </ol>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	309 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	310 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	311 * <b>Usage notes.</b>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	312 * <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	313 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	314 * Pools do not mesh well with using thread-specific storage via
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	315 * java.lang.ThreadLocal. ThreadLocal relies on the identity of a
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	316 * thread executing a particular task. Pools use the same thread to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	317 * perform different tasks. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	318 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	319 * If you need a policy not handled by the parameters in this class
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	320 * consider writing a subclass. <p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	321 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	322 * Version note: Previous versions of this class relied on
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	323 * ThreadGroups for aggregate control. This has been removed, and the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	324 * method interruptAll added, to avoid differences in behavior across
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	325 * JVMs.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	326 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	327 * <p>[<a href="http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/intro.html"> Introduction to this package. </a>]
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	328 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	329
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	330 public class PooledExecutor extends ThreadFactoryUser implements Executor {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	331
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	332 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	333 * The maximum pool size; used if not otherwise specified. Default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	334 * value is essentially infinite (Integer.MAX_VALUE)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	335 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	336 public static final int DEFAULT_MAXIMUMPOOLSIZE = Integer.MAX_VALUE;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	337
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	338 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	339 * The minimum pool size; used if not otherwise specified. Default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	340 * value is 1.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	341 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	342 public static final int DEFAULT_MINIMUMPOOLSIZE = 1;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	343
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	344 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	345 * The maximum time to keep worker threads alive waiting for new
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	346 * tasks; used if not otherwise specified. Default value is one
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	347 * minute (60000 milliseconds).
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	348 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	349 public static final long DEFAULT_KEEPALIVETIME = 60 * 1000;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	350
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	351 / The maximum number of threads allowed in pool. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	352 protected int maximumPoolSize_ = DEFAULT_MAXIMUMPOOLSIZE;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	353
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	354 / The minumum number of threads to maintain in pool. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	355 protected int minimumPoolSize_ = DEFAULT_MINIMUMPOOLSIZE;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	356
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	357 / Current pool size. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	358 protected int poolSize_ = 0;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	359
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	360 / The maximum time for an idle thread to wait for new task. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	361 protected long keepAliveTime_ = DEFAULT_KEEPALIVETIME;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	362
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	363 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	364 * Shutdown flag - latches true when a shutdown method is called
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	365 * in order to disable queuing/handoffs of new tasks.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	366 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	367 protected boolean shutdown_ = false;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	368
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	369 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	370 * The channel used to hand off the command to a thread in the pool.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	371 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	372 protected final Channel handOff_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	373
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	374 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	375 * The set of active threads, declared as a map from workers to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	376 * their threads. This is needed by the interruptAll method. It
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	377 * may also be useful in subclasses that need to perform other
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	378 * thread management chores.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	379 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	380 protected final Map threads_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	381
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	382 / The current handler for unserviceable requests. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	383 protected BlockedExecutionHandler blockedExecutionHandler_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	384
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	385 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	386 * Create a new pool with all default settings
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	387 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	388
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	389 public PooledExecutor() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	390 this (new SynchronousChannel(), DEFAULT_MAXIMUMPOOLSIZE);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	391 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	392
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	393 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	394 * Create a new pool with all default settings except
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	395 * for maximum pool size.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	396 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	397
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	398 public PooledExecutor(int maxPoolSize) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	399 this(new SynchronousChannel(), maxPoolSize);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	400 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	401
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	402 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	403 * Create a new pool that uses the supplied Channel for queuing, and
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	404 * with all default parameter settings.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	405 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	406
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	407 public PooledExecutor(Channel channel) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	408 this(channel, DEFAULT_MAXIMUMPOOLSIZE);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	409 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	410
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	411 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	412 * Create a new pool that uses the supplied Channel for queuing, and
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	413 * with all default parameter settings except for maximum pool size.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	414 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	415
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	416 public PooledExecutor(Channel channel, int maxPoolSize) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	417 maximumPoolSize_ = maxPoolSize;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	418 handOff_ = channel;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	419 runWhenBlocked();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	420 threads_ = new HashMap();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	421 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	422
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	423 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	424 * Return the maximum number of threads to simultaneously execute
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	425 * New unqueued requests will be handled according to the current
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	426 * blocking policy once this limit is exceeded.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	427 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	428 public synchronized int getMaximumPoolSize() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	429 return maximumPoolSize_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	430 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	431
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	432 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	433 * Set the maximum number of threads to use. Decreasing the pool
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	434 * size will not immediately kill existing threads, but they may
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	435 * later die when idle.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	436 * @exception IllegalArgumentException if less or equal to zero.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	437 * (It is
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	438 * not considered an error to set the maximum to be less than than
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	439 * the minimum. However, in this case there are no guarantees
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	440 * about behavior.)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	441 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	442 public synchronized void setMaximumPoolSize(int newMaximum) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	443 if (newMaximum <= 0) throw new IllegalArgumentException();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	444 maximumPoolSize_ = newMaximum;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	445 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	446
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	447 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	448 * Return the minimum number of threads to simultaneously execute.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	449 * (Default value is 1). If fewer than the mininum number are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	450 * running upon reception of a new request, a new thread is started
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	451 * to handle this request.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	452 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	453 public synchronized int getMinimumPoolSize() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	454 return minimumPoolSize_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	455 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	456
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	457 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	458 * Set the minimum number of threads to use.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	459 * @exception IllegalArgumentException if less than zero. (It is not
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	460 * considered an error to set the minimum to be greater than the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	461 * maximum. However, in this case there are no guarantees about
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	462 * behavior.)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	463 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	464 public synchronized void setMinimumPoolSize(int newMinimum) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	465 if (newMinimum < 0) throw new IllegalArgumentException();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	466 minimumPoolSize_ = newMinimum;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	467 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	468
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	469 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	470 * Return the current number of active threads in the pool. This
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	471 * number is just a snaphot, and may change immediately upon
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	472 * returning
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	473 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	474 public synchronized int getPoolSize() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	475 return poolSize_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	476 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	477
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	478 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	479 * Return the number of milliseconds to keep threads alive waiting
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	480 * for new commands. A negative value means to wait forever. A zero
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	481 * value means not to wait at all.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	482 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	483 public synchronized long getKeepAliveTime() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	484 return keepAliveTime_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	485 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	486
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	487 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	488 * Set the number of milliseconds to keep threads alive waiting for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	489 * new commands. A negative value means to wait forever. A zero
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	490 * value means not to wait at all.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	491 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	492 public synchronized void setKeepAliveTime(long msecs) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	493 keepAliveTime_ = msecs;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	494 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	495
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	496 / Get the handler for blocked execution /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	497 public synchronized BlockedExecutionHandler getBlockedExecutionHandler() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	498 return blockedExecutionHandler_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	499 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	500
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	501 / Set the handler for blocked execution /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	502 public synchronized void setBlockedExecutionHandler(BlockedExecutionHandler h) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	503 blockedExecutionHandler_ = h;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	504 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	505
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	506 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	507 * Create and start a thread to handle a new command. Call only
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	508 * when holding lock.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	509 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	510 protected void addThread(Runnable command) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	511 Worker worker = new Worker(command);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	512 Thread thread = getThreadFactory().newThread(worker);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	513 threads_.put(worker, thread);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	514 ++poolSize_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	515 thread.start();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	516 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	517
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	518 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	519 * Create and start up to numberOfThreads threads in the pool.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	520 * Return the number created. This may be less than the number
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	521 * requested if creating more would exceed maximum pool size bound.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	522 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	523 public int createThreads(int numberOfThreads) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	524 int ncreated = 0;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	525 for (int i = 0; i < numberOfThreads; ++i) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	526 synchronized(this) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	527 if (poolSize_ < maximumPoolSize_) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	528 addThread(null);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	529 ++ncreated;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	530 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	531 else
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	532 break;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	533 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	534 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	535 return ncreated;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	536 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	537
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	538 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	539 * Interrupt all threads in the pool, causing them all to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	540 * terminate. Assuming that executed tasks do not disable (clear)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	541 * interruptions, each thread will terminate after processing its
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	542 * current task. Threads will terminate sooner if the executed tasks
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	543 * themselves respond to interrupts.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	544 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	545 public synchronized void interruptAll() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	546 for (Iterator it = threads_.values().iterator(); it.hasNext(); ) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	547 Thread t = (Thread)(it.next());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	548 t.interrupt();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	549 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	550 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	551
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	552 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	553 * Interrupt all threads and disable construction of new
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	554 * threads. Any tasks entered after this point will be discarded. A
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	555 * shut down pool cannot be restarted.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	556 */
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	557 public void shutdownNow() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	558 shutdownNow(new DiscardWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	559 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	560
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	561 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	562 * Interrupt all threads and disable construction of new
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	563 * threads. Any tasks entered after this point will be handled by
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	564 * the given BlockedExecutionHandler. A shut down pool cannot be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	565 * restarted.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	566 */
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	567 public synchronized void shutdownNow(BlockedExecutionHandler handler) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	568 setBlockedExecutionHandler(handler);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	569 shutdown_ = true; // don't allow new tasks
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	570 minimumPoolSize_ = maximumPoolSize_ = 0; // don't make new threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	571 interruptAll(); // interrupt all existing threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	572 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	573
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	574 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	575 * Terminate threads after processing all elements currently in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	576 * queue. Any tasks entered after this point will be discarded. A
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	577 * shut down pool cannot be restarted.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	578 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	579 public void shutdownAfterProcessingCurrentlyQueuedTasks() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	580 shutdownAfterProcessingCurrentlyQueuedTasks(new DiscardWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	581 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	582
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	583 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	584 * Terminate threads after processing all elements currently in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	585 * queue. Any tasks entered after this point will be handled by the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	586 * given BlockedExecutionHandler. A shut down pool cannot be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	587 * restarted.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	588 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	589 public synchronized void shutdownAfterProcessingCurrentlyQueuedTasks(BlockedExecutionHandler handler) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	590 setBlockedExecutionHandler(handler);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	591 shutdown_ = true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	592 if (poolSize_ == 0) // disable new thread construction when idle
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	593 minimumPoolSize_ = maximumPoolSize_ = 0;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	594 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	595
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	596 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	597 * Return true if a shutDown method has succeeded in terminating all
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	598 * threads.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	599 */
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	600 public synchronized boolean isTerminatedAfterShutdown() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	601 return shutdown_ && poolSize_ == 0;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	602 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	603
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	604 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	605 * Wait for a shutdown pool to fully terminate, or until the timeout
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	606 * has expired. This method may only be called <em>after</em>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	607 * invoking shutdownNow or
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	608 * shutdownAfterProcessingCurrentlyQueuedTasks.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	609 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	610 * @param maxWaitTime the maximum time in milliseconds to wait
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	611 * @return true if the pool has terminated within the max wait period
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	612 * @exception IllegalStateException if shutdown has not been requested
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	613 * @exception InterruptedException if the current thread has been interrupted in the course of waiting
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	614 */
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	615 public synchronized boolean awaitTerminationAfterShutdown(long maxWaitTime) throws InterruptedException {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	616 if (!shutdown_)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	617 throw new IllegalStateException();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	618 if (poolSize_ == 0)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	619 return true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	620 long waitTime = maxWaitTime;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	621 if (waitTime <= 0)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	622 return false;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	623 long start = System.currentTimeMillis();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	624 for (;;) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	625 wait(waitTime);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	626 if (poolSize_ == 0)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	627 return true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	628 waitTime = maxWaitTime - (System.currentTimeMillis() - start);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	629 if (waitTime <= 0)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	630 return false;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	631 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	632 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	633
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	634 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	635 * Wait for a shutdown pool to fully terminate. This method may
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	636 * only be called <em>after</em> invoking shutdownNow or
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	637 * shutdownAfterProcessingCurrentlyQueuedTasks.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	638 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	639 * @exception IllegalStateException if shutdown has not been requested
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	640 * @exception InterruptedException if the current thread has been interrupted in the course of waiting
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	641 */
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	642 public synchronized void awaitTerminationAfterShutdown() throws InterruptedException {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	643 if (!shutdown_)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	644 throw new IllegalStateException();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	645 while (poolSize_ > 0)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	646 wait();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	647 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	648
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	649 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	650 * Remove all unprocessed tasks from pool queue, and return them in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	651 * a java.util.List. Thsi method should be used only when there are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	652 * not any active clients of the pool. Otherwise you face the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	653 * possibility that the method will loop pulling out tasks as
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	654 * clients are putting them in. This method can be useful after
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	655 * shutting down a pool (via shutdownNow) to determine whether there
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	656 * are any pending tasks that were not processed. You can then, for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	657 * example execute all unprocessed commands via code along the lines
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	658 * of:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	659 *
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	660 * <pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	661 * List tasks = pool.drain();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	662 * for (Iterator it = tasks.iterator(); it.hasNext();)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	663 * ( (Runnable)(it.next()) ).run();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	664 * </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	665 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	666 public List drain() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	667 boolean wasInterrupted = false;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	668 Vector tasks = new Vector();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	669 for (;;) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	670 try {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	671 Object x = handOff_.poll(0);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	672 if (x == null)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	673 break;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	674 else
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	675 tasks.addElement(x);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	676 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	677 catch (InterruptedException ex) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	678 wasInterrupted = true; // postpone re-interrupt until drained
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	679 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	680 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	681 if (wasInterrupted) Thread.currentThread().interrupt();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	682 return tasks;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	683 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	684
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	685 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	686 * Cleanup method called upon termination of worker thread.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	687 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	688 protected synchronized void workerDone(Worker w) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	689 threads_.remove(w);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	690 if (--poolSize_ == 0 && shutdown_) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	691 maximumPoolSize_ = minimumPoolSize_ = 0; // disable new threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	692 notifyAll(); // notify awaitTerminationAfterShutdown
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	693 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	694 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	695
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	696 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	697 * Get a task from the handoff queue, or null if shutting down.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	698 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	699 protected Runnable getTask() throws InterruptedException {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	700 long waitTime;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	701 synchronized(this) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	702 if (poolSize_ > maximumPoolSize_) // Cause to die if too many threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	703 return null;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	704 waitTime = (shutdown_)? 0 : keepAliveTime_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	705 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	706 if (waitTime >= 0)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	707 return (Runnable)(handOff_.poll(waitTime));
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	708 else
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	709 return (Runnable)(handOff_.take());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	710 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	711
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	712
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	713 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	714 * Class defining the basic run loop for pooled threads.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	715 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	716 protected class Worker implements Runnable {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	717 protected Runnable firstTask_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	718
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	719 protected Worker(Runnable firstTask) { firstTask_ = firstTask; }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	720
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	721 public void run() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	722 try {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	723 Runnable task = firstTask_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	724 firstTask_ = null; // enable GC
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	725
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	726 if (task != null) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	727 task.run();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	728 task = null;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	729 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	730
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	731 while ( (task = getTask()) != null) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	732 task.run();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	733 task = null;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	734 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	735 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	736 catch (InterruptedException ex) { } // fall through
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	737 finally {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	738 workerDone(this);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	739 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	740 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	741 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	742
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	743 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	744 * Class for actions to take when execute() blocks. Uses Strategy
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	745 * pattern to represent different actions. You can add more in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	746 * subclasses, and/or create subclasses of these. If so, you will
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	747 * also want to add or modify the corresponding methods that set the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	748 * current blockedExectionHandler_.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	749 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	750 public interface BlockedExecutionHandler {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	751 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	752 * Return true if successfully handled so, execute should
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	753 * terminate; else return false if execute loop should be retried.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	754 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	755 boolean blockedAction(Runnable command) throws InterruptedException;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	756 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	757
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	758 / Class defining Run action. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	759 protected class RunWhenBlocked implements BlockedExecutionHandler {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	760 public boolean blockedAction(Runnable command) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	761 command.run();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	762 return true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	763 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	764 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	765
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	766 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	767 * Set the policy for blocked execution to be that the current
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	768 * thread executes the command if there are no available threads in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	769 * the pool.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	770 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	771 public void runWhenBlocked() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	772 setBlockedExecutionHandler(new RunWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	773 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	774
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	775 / Class defining Wait action. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	776 protected class WaitWhenBlocked implements BlockedExecutionHandler {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	777 public boolean blockedAction(Runnable command) throws InterruptedException{
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	778 handOff_.put(command);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	779 return true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	780 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	781 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	782
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	783 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	784 * Set the policy for blocked execution to be to wait until a thread
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	785 * is available.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	786 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	787 public void waitWhenBlocked() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	788 setBlockedExecutionHandler(new WaitWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	789 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	790
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	791 / Class defining Discard action. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	792 protected class DiscardWhenBlocked implements BlockedExecutionHandler {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	793 public boolean blockedAction(Runnable command) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	794 return true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	795 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	796 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	797
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	798 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	799 * Set the policy for blocked execution to be to return without
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	800 * executing the request.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	801 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	802 public void discardWhenBlocked() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	803 setBlockedExecutionHandler(new DiscardWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	804 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	805
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	806
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	807 / Class defining Abort action. /
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	808 protected class AbortWhenBlocked implements BlockedExecutionHandler {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	809 public boolean blockedAction(Runnable command) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	810 throw new RuntimeException("Pool is blocked");
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	811 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	812 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	813
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	814 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	815 * Set the policy for blocked execution to be to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	816 * throw a RuntimeException.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	817 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	818 public void abortWhenBlocked() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	819 setBlockedExecutionHandler(new AbortWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	820 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	821
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	822
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	823 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	824 * Class defining DiscardOldest action. Under this policy, at most
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	825 * one old unhandled task is discarded. If the new task can then be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	826 * handed off, it is. Otherwise, the new task is run in the current
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	827 * thread (i.e., RunWhenBlocked is used as a backup policy.)
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	828 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	829 protected class DiscardOldestWhenBlocked implements BlockedExecutionHandler {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	830 public boolean blockedAction(Runnable command) throws InterruptedException{
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	831 handOff_.poll(0);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	832 if (!handOff_.offer(command, 0))
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	833 command.run();
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	834 return true;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	835 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	836 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	837
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	838 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	839 * Set the policy for blocked execution to be to discard the oldest
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	840 * unhandled request
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	841 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	842 public void discardOldestWhenBlocked() {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	843 setBlockedExecutionHandler(new DiscardOldestWhenBlocked());
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	844 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	845
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	846 /**
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	847 * Arrange for the given command to be executed by a thread in this
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	848 * pool. The method normally returns when the command has been
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	849 * handed off for (possibly later) execution.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	850 **/
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	851 public void execute(Runnable command) throws InterruptedException {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	852 for (;;) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	853 synchronized(this) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	854 if (!shutdown_) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	855 int size = poolSize_;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	856
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	857 // Ensure minimum number of threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	858 if (size < minimumPoolSize_) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	859 addThread(command);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	860 return;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	861 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	862
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	863 // Try to give to existing thread
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	864 if (handOff_.offer(command, 0)) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	865 return;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	866 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	867
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	868 // If cannot handoff and still under maximum, create new thread
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	869 if (size < maximumPoolSize_) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	870 addThread(command);
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	871 return;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	872 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	873 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	874 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	875
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	876 // Cannot hand off and cannot create -- ask for help
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	877 if (getBlockedExecutionHandler().blockedAction(command)) {
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	878 return;
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	879 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	880 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	881 }
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	882 }

Mercurial > hg > blitz_stable

annotate src/EDU/oswego/cs/dl/util/concurrent/PooledExecutor.java @ 27:511648fa4d64 Version 2.1