Package org.eclipse.jetty.util.thread

Class ThreadPoolBudget

java.lang.Object

org.eclipse.jetty.util.thread.ThreadPoolBudget

@ManagedObject
public class ThreadPoolBudget
extends Object

A budget of required thread usage, used to warn or error for insufficient configured threads.

See Also:

• ThreadPool.SizedThreadPool.getThreadPoolBudget()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThreadPoolBudget.Lease
class	ThreadPoolBudget.Leased	An allocation of threads

Constructor Summary

Constructors

Constructor	Description
ThreadPoolBudget(ThreadPool.SizedThreadPool pool)	Construct a budget for a SizedThreadPool.

Method Summary

Modifier and Type	Method	Description
boolean	check(int maxThreads)	Checks leases against the given number of maxThreads.
int	getLeasedThreads()
ThreadPool.SizedThreadPool	getSizedThreadPool()
static ThreadPoolBudget.Lease	leaseFrom(Executor executor, Object leasee, int threads)
ThreadPoolBudget.Lease	leaseTo(Object leasee, int threads)
void	reset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThreadPoolBudget

public ThreadPoolBudget(ThreadPool.SizedThreadPool pool)

Construct a budget for a SizedThreadPool.

Parameters:

pool - The pool to budget thread allocation for.

Method Details

getSizedThreadPool

public ThreadPool.SizedThreadPool getSizedThreadPool()

getLeasedThreads

@ManagedAttribute("the number of threads leased to components")
public int getLeasedThreads()

reset

public void reset()

leaseTo

public ThreadPoolBudget.Lease leaseTo(Object leasee,
 int threads)

check

public boolean check(int maxThreads)
              throws IllegalStateException

Checks leases against the given number of maxThreads.

Parameters:

maxThreads - A proposed change to the maximum threads to check.

Returns:

true if passes check, false if otherwise (see logs for details)

Throws:

IllegalStateException - if insufficient threads are configured.

leaseFrom

public static ThreadPoolBudget.Lease leaseFrom(Executor executor,
 Object leasee,
 int threads)