Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Formatting cleanups and added Javadocs.

This commit is contained in:
Simone Bordet 2017-10-06 16:03:03 +02:00
parent b38597a5bc
commit da72bff86a
1 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
jetty-util/src/main/java/org/eclipse/jetty/util/thread/ThreadPool.java
View File

@ -24,53 +24,69 @@ import org.eclipse.jetty.util.annotation.ManagedAttribute;
import org.eclipse.jetty.util.annotation.ManagedObject;
import org.eclipse.jetty.util.component.LifeCycle;
/* ------------------------------------------------------------ */
/** ThreadPool.
*
* A specialization of Executor interface that provides reporting methods (eg {@link #getThreads()})
* and the option of configuration methods (e.g. @link {@link SizedThreadPool#setMaxThreads(int)}).
*
/**
* <p>A pool for threads.</p>
* <p>A specialization of Executor interface that provides reporting methods (eg {@link #getThreads()})
* and the option of configuration methods (e.g. @link {@link SizedThreadPool#setMaxThreads(int)}).</p>
*/
@ManagedObject("Pool of Threads")
public interface ThreadPool extends Executor
{
/* ------------------------------------------------------------ */
/**
* Blocks until the thread pool is {@link LifeCycle#stop stopped}.
*
* @throws InterruptedException if thread was interrupted
*/
public void join() throws InterruptedException;
/* ------------------------------------------------------------ */
/**
* @return The total number of threads currently in the pool
*/
@ManagedAttribute("number of threads in pool")
public int getThreads();
/* ------------------------------------------------------------ */
/**
* @return The number of idle threads in the pool
*/
@ManagedAttribute("number of idle threads in pool")
public int getIdleThreads();
/* ------------------------------------------------------------ */
/**
* @return True if the pool is low on threads
*/
@ManagedAttribute("indicates the pool is low on available threads")
public boolean isLowOnThreads();
/* ------------------------------------------------------------ */
/* ------------------------------------------------------------ */
/**
* <p>Specialized sub-interface of ThreadPool that allows to get/set
* the minimum and maximum number of threads of the pool.</p>
*/
public interface SizedThreadPool extends ThreadPool
{
/**
* @return the minimum number of threads
*/
int getMinThreads();
/**
* @return the maximum number of threads
*/
int getMaxThreads();
/**
* @param threads the minimum number of threads
*/
void setMinThreads(int threads);
/**
* @param threads the maximum number of threads
*/
void setMaxThreads(int threads);
/**
* @return a ThreadPoolBudget for this sized thread pool,
* or null of no ThreadPoolBudget can be returned
*/
default ThreadPoolBudget getThreadPoolBudget()
{
return null;