ThreadPoolConfig (grizzly-framework 2.2.21 API)

java.lang.Object
- org.glassfish.grizzly.threadpool.ThreadPoolConfig

public class ThreadPoolConfig
extends Object

Author:: Oleksiy Stashok, gustav trede

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`corePoolSize`
`protected long`	`keepAliveTimeMillis`
`protected int`	`maxPoolSize`
`protected MemoryManager`	`mm`
`protected String`	`poolName`
`protected int`	`priority`
`protected Queue<Runnable>`	`queue`
`protected int`	`queueLimit`
`protected ThreadFactory`	`threadFactory`
`protected MonitoringConfigImpl<ThreadPoolProbe>`	`threadPoolMonitoringConfig` Thread pool probes
`protected DelayedExecutor`	`transactionMonitor`
`protected long`	`transactionTimeoutMillis`

Constructor Summary

Constructors
Constructor and Description
`ThreadPoolConfig(String poolName, int corePoolSize, int maxPoolSize, Queue<Runnable> queue, int queueLimit, long keepAliveTime, TimeUnit timeUnit, ThreadFactory threadFactory, int priority, MemoryManager mm, DelayedExecutor transactionMonitor, long transactionTimeoutMillis)`
`ThreadPoolConfig(ThreadPoolConfig cfg)`

Method Summary

Methods
Modifier and Type	Method and Description
`ThreadPoolConfig`	`copy()`
`static ThreadPoolConfig`	`defaultConfig()`
`int`	`getCorePoolSize()`
`MonitoringConfigImpl<ThreadPoolProbe>`	`getInitialMonitoringConfig()`
`long`	`getKeepAliveTime(TimeUnit timeUnit)` Returns the max period of time a thread will wait for a new task to process.
`int`	`getMaxPoolSize()`
`MemoryManager`	`getMemoryManager()`
`String`	`getPoolName()`
`int`	`getPriority()`
`Queue<Runnable>`	`getQueue()`
`int`	`getQueueLimit()`
`ThreadFactory`	`getThreadFactory()`
`DelayedExecutor`	`getTransactionMonitor()`
`long`	`getTransactionTimeout(TimeUnit timeUnit)`
`ThreadPoolConfig`	`setCorePoolSize(int corePoolSize)`
`ThreadPoolConfig`	`setKeepAliveTime(long time, TimeUnit unit)` The max period of time a thread will wait for a new task to process.
`ThreadPoolConfig`	`setMaxPoolSize(int maxPoolSize)`
`ThreadPoolConfig`	`setMemoryManager(MemoryManager mm)`
`ThreadPoolConfig`	`setPoolName(String poolname)`
`ThreadPoolConfig`	`setPriority(int priority)`
`ThreadPoolConfig`	`setQueue(Queue<Runnable> queue)`
`ThreadPoolConfig`	`setQueueLimit(int queueLimit)`
`ThreadPoolConfig`	`setThreadFactory(ThreadFactory threadFactory)`
`ThreadPoolConfig`	`setTransactionMonitor(DelayedExecutor transactionMonitor)`
`ThreadPoolConfig`	`setTransactionTimeout(DelayedExecutor transactionMonitor, long transactionTimeout, TimeUnit timeunit)`
`ThreadPoolConfig`	`setTransactionTimeout(long transactionTimeout, TimeUnit timeunit)`
`String`	`toString()`

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

Field Detail

poolName
```
protected String poolName
```

corePoolSize
```
protected int corePoolSize
```

maxPoolSize
```
protected int maxPoolSize
```

queue
```
protected Queue<Runnable> queue
```

queueLimit
```
protected int queueLimit
```

keepAliveTimeMillis
```
protected long keepAliveTimeMillis
```

threadFactory
```
protected ThreadFactory threadFactory
```

priority
```
protected int priority
```

mm
```
protected MemoryManager mm
```

transactionMonitor

protected DelayedExecutor transactionMonitor

transactionTimeoutMillis

protected long transactionTimeoutMillis

threadPoolMonitoringConfig

protected final MonitoringConfigImpl<ThreadPoolProbe> threadPoolMonitoringConfig

Thread pool probes

Constructor Detail

ThreadPoolConfig

public ThreadPoolConfig(String poolName,
                int corePoolSize,
                int maxPoolSize,
                Queue<Runnable> queue,
                int queueLimit,
                long keepAliveTime,
                TimeUnit timeUnit,
                ThreadFactory threadFactory,
                int priority,
                MemoryManager mm,
                DelayedExecutor transactionMonitor,
                long transactionTimeoutMillis)

ThreadPoolConfig

public ThreadPoolConfig(ThreadPoolConfig cfg)

Method Detail
- defaultConfig
```
public static ThreadPoolConfig defaultConfig()
```
- copy
```
public ThreadPoolConfig copy()
```
- getQueue
```
public Queue<Runnable> getQueue()
```
  Returns:
  the queue
- setQueue
```
public ThreadPoolConfig setQueue(Queue<Runnable> queue)
```
  Parameters:
  queue - the queue implemenation to use
  
  Returns:
  the ThreadPoolConfig with the new Queue implementation.
- getThreadFactory
```
public ThreadFactory getThreadFactory()
```
  Returns:
  the threadFactory
- setThreadFactory
```
public ThreadPoolConfig setThreadFactory(ThreadFactory threadFactory)
```
  Parameters:
  threadFactory - custom ThreadFactory
  
  Returns:
  the ThreadPoolConfig with the new ThreadFactory
- getPoolName
```
public String getPoolName()
```
  Returns:
  the poolname
- setPoolName
```
public ThreadPoolConfig setPoolName(String poolname)
```
  Parameters:
  poolname - the thread pool name.
  
  Returns:
  the ThreadPoolConfig with the new thread pool name.
- getPriority
```
public int getPriority()
```
- setPriority
```
public ThreadPoolConfig setPriority(int priority)
```
- getMaxPoolSize
```
public int getMaxPoolSize()
```
  Returns:
  the maxpoolsize
- setMaxPoolSize
```
public ThreadPoolConfig setMaxPoolSize(int maxPoolSize)
```
  Parameters:
  maxPoolSize - the max thread pool size
  
  Returns:
  the ThreadPoolConfig with the new max pool size
- getCorePoolSize
```
public int getCorePoolSize()
```
  Returns:
  the corepoolsize
- setCorePoolSize
```
public ThreadPoolConfig setCorePoolSize(int corePoolSize)
```
  Parameters:
  corePoolSize - the core thread pool size
  
  Returns:
  the ThreadPoolConfig with the new core pool size
- getQueueLimit
```
public int getQueueLimit()
```
  Returns:
  the queuelimit
- setQueueLimit
```
public ThreadPoolConfig setQueueLimit(int queueLimit)
```
  Parameters:
  queueLimit - the queue limit
  
  Returns:
  the ThreadPoolConfig with the new queue limite
- setKeepAliveTime
```
public ThreadPoolConfig setKeepAliveTime(long time,
                                TimeUnit unit)
```
  The max period of time a thread will wait for a new task to process. If the timeout expires and the thread is not a core one (see setCorePoolSize(int), setMaxPoolSize(int)) - then the thread will be terminated and removed from the thread pool.
  
  Parameters:
  time - max keep alive timeout. The value less than 0 means no timeout
  unit - time unit
  
  Returns:
  the ThreadPoolConfig with the new keep alive time
- getKeepAliveTime
```
public long getKeepAliveTime(TimeUnit timeUnit)
```
  Returns the max period of time a thread will wait for a new task to process. If the timeout expires and the thread is not a core one (see setCorePoolSize(int), setMaxPoolSize(int)) - then the thread will be terminated and removed from the thread pool.
  
  Returns:
  the keep-alive timeout, the value less than 0 means no timeout
- getMemoryManager
```
public MemoryManager getMemoryManager()
```
- setMemoryManager
```
public ThreadPoolConfig setMemoryManager(MemoryManager mm)
```
- getInitialMonitoringConfig
```
public MonitoringConfigImpl<ThreadPoolProbe> getInitialMonitoringConfig()
```
- getTransactionMonitor
```
public DelayedExecutor getTransactionMonitor()
```
- setTransactionMonitor
```
public ThreadPoolConfig setTransactionMonitor(DelayedExecutor transactionMonitor)
```
- getTransactionTimeout
```
public long getTransactionTimeout(TimeUnit timeUnit)
```
- setTransactionTimeout
```
public ThreadPoolConfig setTransactionTimeout(long transactionTimeout,
                                     TimeUnit timeunit)
```
- setTransactionTimeout
```
public ThreadPoolConfig setTransactionTimeout(DelayedExecutor transactionMonitor,
                                     long transactionTimeout,
                                     TimeUnit timeunit)
```
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object

Class ThreadPoolConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

poolName

corePoolSize

maxPoolSize

queue

queueLimit

keepAliveTimeMillis

threadFactory

priority

mm

transactionMonitor

transactionTimeoutMillis

threadPoolMonitoringConfig

Constructor Detail

ThreadPoolConfig

ThreadPoolConfig

Method Detail

defaultConfig

copy

getQueue

setQueue

getThreadFactory

setThreadFactory

getPoolName

setPoolName

getPriority

setPriority

getMaxPoolSize

setMaxPoolSize

getCorePoolSize

setCorePoolSize

getQueueLimit

setQueueLimit

setKeepAliveTime

getKeepAliveTime

getMemoryManager

setMemoryManager

getInitialMonitoringConfig

getTransactionMonitor

setTransactionMonitor

getTransactionTimeout

setTransactionTimeout

setTransactionTimeout

toString