LogicalThreadPool (taskmaster-core 1.0.2 API)

java.lang.Object
- com.github.bordertech.taskmaster.logical.LogicalThreadPool

All Implemented Interfaces:

Serializable
```
public class LogicalThreadPool
extends Object
implements Serializable
```
User session logical thread pool details.
Can be used to control a logical pool of threads per user session.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

LogicalThreadPool()
Default constructor with default name and no limit to threads.

LogicalThreadPool(String name, int max)

Constructors
Constructor and Description
`LogicalThreadPool()` Default constructor with default name and no limit to threads.
`LogicalThreadPool(String name, int max)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`checkPoolStatus()` Check if the pool is OK for processing.
`void`	`finished()` Called when a thread finishes processing.
`boolean`	`getAccess()`
`boolean`	`getAccess(long timeout, TimeUnit unit)`
`int`	`getCurrent()`
`int`	`getMax()`
`String`	`getName()`
`boolean`	`isShutdown()`
`protected void`	`setShutdown(boolean shutdown)`
`void`	`shutdownPool()` Shutdown the thread pool.
`void`	`startPool()` Start the thread pool.
`void`	`waitAccess()` Wait till a thread is available.
`void`	`waitAccess(int waitInterval, int maxWaitIntervals)` Wait till a thread is available.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LogicalThreadPool
```
public LogicalThreadPool()
```
    Default constructor with default name and no limit to threads.
  - LogicalThreadPool
```
public LogicalThreadPool(String name,
                         int max)
```
    Parameters:
    
    name - thread pool name
    
    max - the maximum threads. Zero means no limit.
- Method Detail
  - getName
```
public final String getName()
```
    Returns:
    
    the thread pool name
  - getMax
```
public final int getMax()
```
    Returns:
    
    the maximum threads
  - getCurrent
```
public int getCurrent()
```
    Returns:
    
    the current threads in use
  - isShutdown
```
public boolean isShutdown()
```
    Returns:
    
    true if thread pool is shutdown
  - shutdownPool
```
public void shutdownPool()
```
    Shutdown the thread pool.
  - startPool
```
public void startPool()
```
    Start the thread pool.
  - finished
```
public void finished()
```
    Called when a thread finishes processing.
  - getAccess
```
public boolean getAccess()
```
    Returns:
    
    true if thread pool has available threads
  - getAccess
```
public boolean getAccess(long timeout,
                         TimeUnit unit)
```
    Parameters:
    
    timeout - the wait interval
    
    unit - the interval unit
    
    Returns:
    
    true if the thread pool has available threads
  - waitAccess
```
public void waitAccess()
```
    Wait till a thread is available.
    Must call finished on pool to release the thread in the pool.
  - waitAccess
```
public void waitAccess(int waitInterval,
                       int maxWaitIntervals)
```
    Wait till a thread is available.
    Must call finished on pool to release the thread in the pool.
    
    Parameters:
    
    waitInterval - the wait interval in milliseconds
    
    maxWaitIntervals - the max number of waits
  - checkPoolStatus
```
protected void checkPoolStatus()
```
    Check if the pool is OK for processing.
  - setShutdown
```
protected void setShutdown(boolean shutdown)
```
    Parameters:
    
    shutdown - true if pool shutdown for processing

Class LogicalThreadPool

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LogicalThreadPool

LogicalThreadPool

Method Detail

getName

getMax

getCurrent

isShutdown

shutdownPool

startPool

finished

getAccess

getAccess

waitAccess

waitAccess

checkPoolStatus

setShutdown