Grizzly NIO 5.0.2 · org.glassfish.grizzly.threadpool.ThreadPoolConfig

Modifier and Type	Field and Description
protected int	corePoolSize
private static final ThreadPoolConfig	DEFAULT
protected ClassLoader	initialClassLoader
protected boolean	isDaemon
protected long	keepAliveTimeMillis
protected int	maxPoolSize
protected MemoryManager<E extends Buffer>	mm
protected String	poolName
protected int	priority
protected Queue<Runnable>	queue
protected int	queueLimit
protected ThreadFactory	threadFactory
protected final DefaultMonitoringConfig<ThreadPoolProbe>	threadPoolMonitoringConfig Thread pool probes
protected DelayedExecutor	transactionMonitor
protected long	transactionTimeoutMillis

Access	Constructor and Description
private	ThreadPoolConfig(String poolName, int corePoolSize, int maxPoolSize, Queue<Runnable> queue, int queueLimit, long keepAliveTime, TimeUnit timeUnit, ThreadFactory threadFactory, int priority, boolean isDaemon, MemoryManager<E extends Buffer> mm, DelayedExecutor transactionMonitor, long transactionTimeoutMillis, ClassLoader initialClassLoader)
private	ThreadPoolConfig(ThreadPoolConfig cfg)

Method Summary

Modifier and Type	Method and Description
public ThreadPoolConfig	copy()
public static ThreadPoolConfig	Returns: the Grizzly thread-pool configuration instance. defaultConfig() Create new Grizzly thread-pool configuration instance.
public int	getCorePoolSize() Returns: the corepoolsize
public ClassLoader	getInitialClassLoader() Returns: the classloader (if any) to be initially exposed by threads from this pool.
public DefaultMonitoringConfig<ThreadPoolProbe>	getInitialMonitoringConfig()
public long	Returns: the keep-alive timeout, the value less than 0 means no timeout getKeepAliveTime(TimeUnit timeUnit) Returns the max period of time a thread will wait for a new task to process.
public int	getMaxPoolSize() Returns: the maxpoolsize
public MemoryManager<E extends Buffer>	getMemoryManager()
public String	getPoolName() Returns: the poolname
public int	getPriority()
public Queue<Runnable>	getQueue() Returns: the queue
public int	getQueueLimit() Returns: the thread-pool queue limit.
public ThreadFactory	Returns: the threadFactory getThreadFactory() Returns `ThreadFactory`.
public DelayedExecutor	getTransactionMonitor()
public long	getTransactionTimeout(final TimeUnit timeUnit)
public boolean	isDaemon()
public ThreadPoolConfig	setCorePoolSize(int the core thread pool size corePoolSize) Returns: the `ThreadPoolConfig` with the new core pool size
public ThreadPoolConfig	setDaemon(boolean isDaemon)
public ThreadPoolConfig	Returns: the `ThreadPoolConfig` setInitialClassLoader(final ClassLoader the classloader to be exposed by threads of this pool. initialClassLoader) Specifies the context classloader that will be used by threads in this pool.
public ThreadPoolConfig	Returns: the `ThreadPoolConfig` with the new keep alive time setKeepAliveTime(long max keep alive timeout. The value less than 0 means no timeout time, TimeUnit time unit unit) The max period of time a thread will wait for a new task to process.
public ThreadPoolConfig	setMaxPoolSize(int the max thread pool size maxPoolSize) Returns: the `ThreadPoolConfig` with the new max pool size
public ThreadPoolConfig	setMemoryManager(MemoryManager<E extends Buffer> mm)
public ThreadPoolConfig	setPoolName(String the thread pool name. poolname) Returns: the `ThreadPoolConfig` with the new thread pool name.
public ThreadPoolConfig	setPriority(int priority)
public ThreadPoolConfig	setQueue(Queue<Runnable> the queue implemenation to use queue) Returns: the `ThreadPoolConfig` with the new `Queue` implementation.
public ThreadPoolConfig	setQueueLimit(int the thread-pool queue limit. The `queueLimit` value less than 0 means unlimited queue. queueLimit) Returns: the `ThreadPoolConfig` with the new queue limite
public ThreadPoolConfig	setThreadFactory(ThreadFactory custom `ThreadFactory` If `ThreadFactory` is set - then `priority`, `isDaemon`, `poolName` settings will not be considered when creating new threads. threadFactory) Returns: the `ThreadPoolConfig` with the new `ThreadFactory`
public ThreadPoolConfig	setTransactionMonitor(final DelayedExecutor transactionMonitor)
public ThreadPoolConfig	setTransactionTimeout(final long transactionTimeout, final TimeUnit timeunit)
public ThreadPoolConfig	setTransactionTimeout(final DelayedExecutor transactionMonitor, final long transactionTimeout, final TimeUnit timeunit)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

corePoolSize	back to summary
protected int corePoolSize

DEFAULT	back to summary
private static final ThreadPoolConfig DEFAULT

initialClassLoader	back to summary
protected ClassLoader initialClassLoader

isDaemon	back to summary
protected boolean isDaemon

keepAliveTimeMillis	back to summary
protected long keepAliveTimeMillis

maxPoolSize	back to summary
protected int maxPoolSize

mm	back to summary
protected MemoryManager<E extends Buffer> mm

poolName	back to summary
protected String poolName

priority	back to summary
protected int priority

queue	back to summary
protected Queue<Runnable> queue

queueLimit	back to summary
protected int queueLimit

threadFactory	back to summary
protected ThreadFactory threadFactory

threadPoolMonitoringConfig	back to summary
protected final DefaultMonitoringConfig<ThreadPoolProbe> threadPoolMonitoringConfig Thread pool probes

transactionMonitor	back to summary
protected DelayedExecutor transactionMonitor

transactionTimeoutMillis	back to summary
protected long transactionTimeoutMillis

ThreadPoolConfig	back to summary
private ThreadPoolConfig(String poolName, int corePoolSize, int maxPoolSize, Queue<Runnable> queue, int queueLimit, long keepAliveTime, TimeUnit timeUnit, ThreadFactory threadFactory, int priority, boolean isDaemon, MemoryManager<E extends Buffer> mm, DelayedExecutor transactionMonitor, long transactionTimeoutMillis, ClassLoader initialClassLoader)

ThreadPoolConfig	back to summary
private ThreadPoolConfig(ThreadPoolConfig cfg)

Method Detail

copy	back to summary
public ThreadPoolConfig copy()

defaultConfig back to summary

defaultConfig	back to summary
public static ThreadPoolConfig defaultConfig() Create new Grizzly thread-pool configuration instance. The returned `ThreadPoolConfig` instance will be pre-configured with a default values. Returns:ThreadPoolConfig the Grizzly thread-pool configuration instance.

public static ThreadPoolConfig defaultConfig()

Create new Grizzly thread-pool configuration instance. The returned ThreadPoolConfig instance will be pre-configured with a default values.

Returns:ThreadPoolConfig: the Grizzly thread-pool configuration instance.

getCorePoolSize	back to summary
public int getCorePoolSize() Returns:int the corepoolsize

getInitialClassLoader	back to summary
public ClassLoader getInitialClassLoader() Returns:ClassLoader the classloader (if any) to be initially exposed by threads from this pool. Since 2.3

getInitialMonitoringConfig	back to summary
public DefaultMonitoringConfig<ThreadPoolProbe> getInitialMonitoringConfig()

getKeepAliveTime back to summary

getKeepAliveTime	back to summary
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:long the keep-alive timeout, the value less than 0 means no timeout

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:long: the keep-alive timeout, the value less than 0 means no timeout

getMaxPoolSize	back to summary
public int getMaxPoolSize() Returns:int the maxpoolsize

getMemoryManager	back to summary
public MemoryManager<E extends Buffer> getMemoryManager()

getPoolName	back to summary
public String getPoolName() Returns:String the poolname

getPriority	back to summary
public int getPriority()

getQueue	back to summary
public Queue<Runnable> getQueue() Returns:Queue<Runnable> the queue

getQueueLimit	back to summary
public int getQueueLimit() Returns:int the thread-pool queue limit. The queue limit value less than 0 means unlimited queue.

getThreadFactory back to summary

getThreadFactory	back to summary
public ThreadFactory getThreadFactory() Returns `ThreadFactory`. If `ThreadFactory` is set - then `priority`, `isDaemon`, `poolName` settings will not be considered when creating new threads. Returns:ThreadFactory the threadFactory

public ThreadFactory getThreadFactory()

Returns ThreadFactory. If ThreadFactory is set - then priority, isDaemon, poolName settings will not be considered when creating new threads.

Returns:ThreadFactory: the threadFactory

getTransactionMonitor	back to summary
public DelayedExecutor getTransactionMonitor()

getTransactionTimeout	back to summary
public long getTransactionTimeout(final TimeUnit timeUnit)

isDaemon	back to summary
public boolean isDaemon()

setCorePoolSize	back to summary
public ThreadPoolConfig setCorePoolSize(int corePoolSize) Parameters corePoolSize:int the core thread pool size Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new core pool size

setDaemon	back to summary
public ThreadPoolConfig setDaemon(boolean isDaemon)

setInitialClassLoader back to summary

setInitialClassLoader	back to summary
public ThreadPoolConfig setInitialClassLoader(final ClassLoader initialClassLoader) Specifies the context classloader that will be used by threads in this pool. If not specified, the classloader of the parent thread that initialized the pool will be used. Parameters initialClassLoader:ClassLoader the classloader to be exposed by threads of this pool. Returns:ThreadPoolConfig the `ThreadPoolConfig` Since 2.3 See Also `Thread#getContextClassLoader()`

public ThreadPoolConfig setInitialClassLoader(final ClassLoader initialClassLoader)

Specifies the context classloader that will be used by threads in this pool. If not specified, the classloader of the parent thread that initialized the pool will be used.

Parameters

initialClassLoader:ClassLoader: the classloader to be exposed by threads of this pool.

Returns:ThreadPoolConfig

the ThreadPoolConfig

Since

2.3

See Also

Thread#getContextClassLoader()

setKeepAliveTime back to summary

setKeepAliveTime	back to summary
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:long max keep alive timeout. The value less than 0 means no timeout unit:TimeUnit time unit Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new keep alive time

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:long: max keep alive timeout. The value less than 0 means no timeout
unit:TimeUnit: time unit

Returns:ThreadPoolConfig

the ThreadPoolConfig with the new keep alive time

setMaxPoolSize	back to summary
public ThreadPoolConfig setMaxPoolSize(int maxPoolSize) Parameters maxPoolSize:int the max thread pool size Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new max pool size

setMemoryManager	back to summary
public ThreadPoolConfig setMemoryManager(MemoryManager<E extends Buffer> mm)

setPoolName	back to summary
public ThreadPoolConfig setPoolName(String poolname) Parameters poolname:String the thread pool name. Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new thread pool name.

setPriority	back to summary
public ThreadPoolConfig setPriority(int priority)

setQueue	back to summary
public ThreadPoolConfig setQueue(Queue<Runnable> queue) Parameters queue:Queue<Runnable> the queue implemenation to use Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new `Queue` implementation.

setQueueLimit	back to summary
public ThreadPoolConfig setQueueLimit(int queueLimit) Parameters queueLimit:int the thread-pool queue limit. The `queueLimit` value less than 0 means unlimited queue. Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new queue limite

setThreadFactory	back to summary
public ThreadPoolConfig setThreadFactory(ThreadFactory threadFactory) Parameters threadFactory:ThreadFactory custom `ThreadFactory` If `ThreadFactory` is set - then `priority`, `isDaemon`, `poolName` settings will not be considered when creating new threads. Returns:ThreadPoolConfig the `ThreadPoolConfig` with the new `ThreadFactory`

setTransactionMonitor	back to summary
public ThreadPoolConfig setTransactionMonitor(final DelayedExecutor transactionMonitor)

setTransactionTimeout	back to summary
public ThreadPoolConfig setTransactionTimeout(final long transactionTimeout, final TimeUnit timeunit)

setTransactionTimeout	back to summary
public ThreadPoolConfig setTransactionTimeout(final DelayedExecutor transactionMonitor, final long transactionTimeout, final TimeUnit timeunit)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public final Class ThreadPoolConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail