Package org.eclipse.jetty.util.thread
Class QueuedThreadPool
- java.lang.Object
-
- org.eclipse.jetty.util.component.AbstractLifeCycle
-
- org.eclipse.jetty.util.component.ContainerLifeCycle
-
- org.eclipse.jetty.util.thread.QueuedThreadPool
-
- All Implemented Interfaces:
java.util.concurrent.Executor
,java.util.concurrent.ThreadFactory
,Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,LifeCycle
,ThreadPool
,ThreadPool.SizedThreadPool
,TryExecutor
- Direct Known Subclasses:
MonitoredQueuedThreadPool
@ManagedObject("A thread pool") public class QueuedThreadPool extends ContainerLifeCycle implements java.util.concurrent.ThreadFactory, ThreadPool.SizedThreadPool, Dumpable, TryExecutor
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
Container.InheritedListener, Container.Listener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.ThreadPool
ThreadPool.SizedThreadPool
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.TryExecutor
TryExecutor.NoTryExecutor
-
-
Field Summary
-
Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING
-
Fields inherited from interface org.eclipse.jetty.util.thread.TryExecutor
NO_TRY
-
-
Constructor Summary
Constructors Constructor Description QueuedThreadPool()
QueuedThreadPool(int maxThreads)
QueuedThreadPool(int maxThreads, int minThreads)
QueuedThreadPool(int maxThreads, int minThreads, int idleTimeout)
QueuedThreadPool(int maxThreads, int minThreads, int idleTimeout, int reservedThreads, java.util.concurrent.BlockingQueue<java.lang.Runnable> queue, java.lang.ThreadGroup threadGroup)
QueuedThreadPool(int maxThreads, int minThreads, int idleTimeout, int reservedThreads, java.util.concurrent.BlockingQueue<java.lang.Runnable> queue, java.lang.ThreadGroup threadGroup, java.util.concurrent.ThreadFactory threadFactory)
QueuedThreadPool(int maxThreads, int minThreads, int idleTimeout, java.util.concurrent.BlockingQueue<java.lang.Runnable> queue)
QueuedThreadPool(int maxThreads, int minThreads, int idleTimeout, java.util.concurrent.BlockingQueue<java.lang.Runnable> queue, java.lang.ThreadGroup threadGroup)
QueuedThreadPool(int maxThreads, int minThreads, java.util.concurrent.BlockingQueue<java.lang.Runnable> queue)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
dump(java.lang.Appendable out, java.lang.String indent)
Dump this object (and children) into an Appendable using the provided indent after any new lines.java.lang.String
dumpThread(long id)
void
execute(java.lang.Runnable job)
int
getBusyThreads()
int
getIdleThreads()
int
getIdleTimeout()
Get the maximum thread idle time.int
getLowThreadsThreshold()
int
getMaxThreads()
Get the maximum number of threads.int
getMinThreads()
Get the minimum number of threads.java.lang.String
getName()
int
getQueueSize()
Get the size of the job queue.int
getReservedThreads()
Get the number of reserved threads.ThreadPoolBudget
getThreadPoolBudget()
int
getThreads()
int
getThreadsPriority()
Get the priority of the pool threads.boolean
interruptThread(long id)
boolean
isDaemon()
boolean
isDetailedDump()
boolean
isLowOnThreads()
Returns whether this thread pool is low on threads.void
join()
Blocks until the thread pool isstopped
.java.lang.Thread
newThread(java.lang.Runnable runnable)
void
setDaemon(boolean daemon)
Thread Pool should use Daemon Threading.void
setDetailedDump(boolean detailedDump)
void
setIdleTimeout(int idleTimeout)
Set the maximum thread idle time.void
setLowThreadsThreshold(int lowThreadsThreshold)
void
setMaxThreads(int maxThreads)
Set the maximum number of threads.void
setMinThreads(int minThreads)
Set the minimum number of threads.void
setName(java.lang.String name)
void
setQueue(java.util.concurrent.BlockingQueue<java.lang.Runnable> queue)
Deprecated.pass the queue to the constructor insteadvoid
setReservedThreads(int reservedThreads)
Set the number of reserved threads.void
setThreadPoolBudget(ThreadPoolBudget budget)
void
setThreadsPriority(int priority)
Set the priority of the pool threads.java.lang.String
toString()
boolean
tryExecute(java.lang.Runnable task)
Attempt to execute a task.-
Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
-
-
-
Constructor Detail
-
QueuedThreadPool
public QueuedThreadPool()
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads, @Name("queue") java.util.concurrent.BlockingQueue<java.lang.Runnable> queue)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads, @Name("idleTimeout") int idleTimeout)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads, @Name("idleTimeout") int idleTimeout, @Name("queue") java.util.concurrent.BlockingQueue<java.lang.Runnable> queue)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads, @Name("idleTimeout") int idleTimeout, @Name("queue") java.util.concurrent.BlockingQueue<java.lang.Runnable> queue, @Name("threadGroup") java.lang.ThreadGroup threadGroup)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads, @Name("idleTimeout") int idleTimeout, @Name("reservedThreads") int reservedThreads, @Name("queue") java.util.concurrent.BlockingQueue<java.lang.Runnable> queue, @Name("threadGroup") java.lang.ThreadGroup threadGroup)
-
QueuedThreadPool
public QueuedThreadPool(@Name("maxThreads") int maxThreads, @Name("minThreads") int minThreads, @Name("idleTimeout") int idleTimeout, @Name("reservedThreads") int reservedThreads, @Name("queue") java.util.concurrent.BlockingQueue<java.lang.Runnable> queue, @Name("threadGroup") java.lang.ThreadGroup threadGroup, @Name("threadFactory") java.util.concurrent.ThreadFactory threadFactory)
-
-
Method Detail
-
getThreadPoolBudget
public ThreadPoolBudget getThreadPoolBudget()
- Specified by:
getThreadPoolBudget
in interfaceThreadPool.SizedThreadPool
- Returns:
- a ThreadPoolBudget for this sized thread pool, or null of no ThreadPoolBudget can be returned
-
setThreadPoolBudget
public void setThreadPoolBudget(ThreadPoolBudget budget)
-
setDaemon
public void setDaemon(boolean daemon)
Thread Pool should use Daemon Threading.- Parameters:
daemon
- true to enable delegation- See Also:
Thread.setDaemon(boolean)
-
setIdleTimeout
public void setIdleTimeout(int idleTimeout)
Set the maximum thread idle time. Threads that are idle for longer than this period may be stopped.- Parameters:
idleTimeout
- Max idle time in ms.- See Also:
getIdleTimeout()
-
setMaxThreads
public void setMaxThreads(int maxThreads)
Set the maximum number of threads.- Specified by:
setMaxThreads
in interfaceThreadPool.SizedThreadPool
- Parameters:
maxThreads
- maximum number of threads.- See Also:
getMaxThreads()
-
setMinThreads
public void setMinThreads(int minThreads)
Set the minimum number of threads.- Specified by:
setMinThreads
in interfaceThreadPool.SizedThreadPool
- Parameters:
minThreads
- minimum number of threads- See Also:
getMinThreads()
-
setReservedThreads
public void setReservedThreads(int reservedThreads)
Set the number of reserved threads.- Parameters:
reservedThreads
- number of reserved threads or -1 for heuristically determined- See Also:
getReservedThreads()
-
setName
public void setName(java.lang.String name)
- Parameters:
name
- Name of this thread pool to use when naming threads.
-
setThreadsPriority
public void setThreadsPriority(int priority)
Set the priority of the pool threads.- Parameters:
priority
- the new thread priority.
-
getIdleTimeout
@ManagedAttribute("maximum time a thread may be idle in ms") public int getIdleTimeout()
Get the maximum thread idle time.- Returns:
- Max idle time in ms.
- See Also:
setIdleTimeout(int)
-
getMaxThreads
@ManagedAttribute("maximum number of threads in the pool") public int getMaxThreads()
Get the maximum number of threads.- Specified by:
getMaxThreads
in interfaceThreadPool.SizedThreadPool
- Returns:
- maximum number of threads.
- See Also:
setMaxThreads(int)
-
getMinThreads
@ManagedAttribute("minimum number of threads in the pool") public int getMinThreads()
Get the minimum number of threads.- Specified by:
getMinThreads
in interfaceThreadPool.SizedThreadPool
- Returns:
- minimum number of threads.
- See Also:
setMinThreads(int)
-
getReservedThreads
@ManagedAttribute("the number of reserved threads in the pool") public int getReservedThreads()
Get the number of reserved threads.- Returns:
- number of reserved threads or or -1 for heuristically determined
- See Also:
setReservedThreads(int)
-
getName
@ManagedAttribute("name of the thread pool") public java.lang.String getName()
- Returns:
- The name of the this thread pool
-
getThreadsPriority
@ManagedAttribute("priority of threads in the pool") public int getThreadsPriority()
Get the priority of the pool threads.- Returns:
- the priority of the pool threads.
-
getQueueSize
@ManagedAttribute("size of the job queue") public int getQueueSize()
Get the size of the job queue.- Returns:
- Number of jobs queued waiting for a thread
-
isDaemon
@ManagedAttribute("thread pool uses daemon threads") public boolean isDaemon()
- Returns:
- whether this thread pool is using daemon threads
- See Also:
Thread.setDaemon(boolean)
-
isDetailedDump
@ManagedAttribute("reports additional details in the dump") public boolean isDetailedDump()
-
setDetailedDump
public void setDetailedDump(boolean detailedDump)
-
getLowThreadsThreshold
@ManagedAttribute("threshold at which the pool is low on threads") public int getLowThreadsThreshold()
-
setLowThreadsThreshold
public void setLowThreadsThreshold(int lowThreadsThreshold)
-
execute
public void execute(java.lang.Runnable job)
- Specified by:
execute
in interfacejava.util.concurrent.Executor
- Specified by:
execute
in interfaceTryExecutor
-
tryExecute
public boolean tryExecute(java.lang.Runnable task)
Description copied from interface:TryExecutor
Attempt to execute a task.- Specified by:
tryExecute
in interfaceTryExecutor
- Parameters:
task
- The task to be executed- Returns:
- True IFF the task has been given directly to a thread to execute. The task cannot be queued pending the later availability of a Thread.
-
join
public void join() throws java.lang.InterruptedException
Blocks until the thread pool isstopped
.- Specified by:
join
in interfaceThreadPool
- Throws:
java.lang.InterruptedException
- if thread was interrupted
-
getThreads
@ManagedAttribute("number of threads in the pool") public int getThreads()
- Specified by:
getThreads
in interfaceThreadPool
- Returns:
- the total number of threads currently in the pool
-
getIdleThreads
@ManagedAttribute("number of idle threads in the pool") public int getIdleThreads()
- Specified by:
getIdleThreads
in interfaceThreadPool
- Returns:
- the number of idle threads in the pool
-
getBusyThreads
@ManagedAttribute("number of busy threads in the pool") public int getBusyThreads()
- Returns:
- the number of busy threads in the pool
-
isLowOnThreads
@ManagedAttribute(value="thread pool is low on threads", readonly=true) public boolean isLowOnThreads()
Returns whether this thread pool is low on threads.
The current formula is:
maxThreads - threads + idleThreads - queueSize <= lowThreadsThreshold
- Specified by:
isLowOnThreads
in interfaceThreadPool
- Returns:
- whether the pool is low on threads
- See Also:
getLowThreadsThreshold()
-
newThread
public java.lang.Thread newThread(java.lang.Runnable runnable)
- Specified by:
newThread
in interfacejava.util.concurrent.ThreadFactory
-
dump
public void dump(java.lang.Appendable out, java.lang.String indent) throws java.io.IOException
Description copied from interface:Dumpable
Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.- Specified by:
dump
in interfaceDumpable
- Overrides:
dump
in classContainerLifeCycle
- Parameters:
out
- The appendable to dump toindent
- The indent to apply after any new lines.- Throws:
java.io.IOException
- if unable to write to Appendable
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractLifeCycle
-
setQueue
@Deprecated public void setQueue(java.util.concurrent.BlockingQueue<java.lang.Runnable> queue)
Deprecated.pass the queue to the constructor instead- Parameters:
queue
- the job queue
-
interruptThread
@ManagedOperation("interrupts a pool thread") public boolean interruptThread(@Name("id") long id)
- Parameters:
id
- the thread ID to interrupt.- Returns:
- true if the thread was found and interrupted.
-
dumpThread
@ManagedOperation("dumps a pool thread stack") public java.lang.String dumpThread(@Name("id") long id)
- Parameters:
id
- the thread ID to interrupt.- Returns:
- the stack frames dump
-
-