Class ThreadPoolConfig
java.lang.Object
org.glassfish.jersey.jdk.connector.internal.ThreadPoolConfig
Client thread pool configuration, which might be used to customize client thread pool.
One can get a default ThreadPoolConfig using
defaultConfig()
and customize it according to the application specific requirements.
A ThreadPoolConfig object might be customized in a "Builder"-like fashion:
ThreadPoolConfig.defaultConfig() .setPoolName("App1Pool") .setCorePoolSize(5) .setMaxPoolSize(10);
- Author:
- Oleksiy Stashok, gustav trede
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Return a copy of this thread pool config.static ThreadPoolConfig
Create new client thread pool configuration instance.boolean
int
Get the core thread pool size - the size of the thread pool will never bee smaller than this.Get the class loader (if any) to be initially exposed by threads from this pool.long
getKeepAliveTime
(TimeUnit timeUnit) Get the max period of time a thread will wait for a new task to process.int
Get max thread pool size.Return thread pool name.int
Get priority of the threads in thread pool.getQueue()
Return a queue that will be used to temporarily store tasks when all threads in the thread pool are busy.int
Get the limit of the queue, where tasks are temporarily stored when all threads are busy.ReturnThreadFactory
that will be used to create thread pool threads.int
hashCode()
boolean
isDaemon()
Returntrue
if thread pool threads are daemons.setCorePoolSize
(int corePoolSize) Set the core thread pool size - the size of the thread pool will never bee smaller than this.setDaemon
(boolean isDaemon) Settrue
if thread pool threads are daemons.setInitialClassLoader
(ClassLoader initialClassLoader) Specifies the context class loader that will be used by threads in this pool.setKeepAliveTime
(long time, TimeUnit unit) The max period of time a thread will wait for a new task to process.setMaxPoolSize
(int maxPoolSize) Set max thread pool size.setPoolName
(String poolName) Set thread pool name.setPriority
(int priority) Set priority of the threads in thread pool.Set a queue implementation that will be used to temporarily store tasks when all threads in the thread pool are busy.setQueueLimit
(int queueLimit) Set the limit of the queue, where tasks are temporarily stored when all threads are busy.setThreadFactory
(ThreadFactory threadFactory) SetThreadFactory
that will be used to create thread pool threads.toString()
-
Method Details
-
defaultConfig
Create new client thread pool configuration instance. The returned ThreadPoolConfig instance will be pre-configured with a default values.- Returns:
- client thread pool configuration instance.
-
copy
Return a copy of this thread pool config.- Returns:
- a copy of this thread pool config.
-
getQueue
Return a queue that will be used to temporarily store tasks when all threads in the thread pool are busy.- Returns:
- queue that will be used to temporarily store tasks when all threads in the thread pool are busy.
-
setQueue
Set a queue implementation that will be used to temporarily store tasks when all threads in the thread pool are busy.- Parameters:
queue
- queue implementation that will be used to temporarily store tasks when all threads in the thread pool are busy.- Returns:
- the
ThreadPoolConfig
with the newQueue
implementation.
-
getThreadFactory
ReturnThreadFactory
that will be used to create thread pool threads. IfThreadFactory
is set, thenpriority
,isDaemon
,poolName
settings will not be considered when creating new threads.- Returns:
ThreadFactory
that will be used to create thread pool threads.
-
setThreadFactory
SetThreadFactory
that will be used to create thread pool threads.- Parameters:
threadFactory
- customThreadFactory
IfThreadFactory
is set, thenpriority
,isDaemon
,poolName
settings will not be considered when creating new threads.- Returns:
- the
ThreadPoolConfig
with the newThreadFactory
-
getPoolName
Return thread pool name. The default is "Tyrus-client".- Returns:
- the thread pool name.
-
setPoolName
Set thread pool name. The default is "Tyrus-client".- Parameters:
poolName
- the thread pool name.- Returns:
- the
ThreadPoolConfig
with the new thread pool name.
-
getPriority
public int getPriority()Get priority of the threads in thread pool. The default isThread.NORM_PRIORITY
.- Returns:
- priority of the threads in thread pool.
-
setPriority
Set priority of the threads in thread pool. The default isThread.NORM_PRIORITY
.- Parameters:
priority
- of the threads in thread pool.- Returns:
- the
ThreadPoolConfig
with the new thread priority.
-
isDaemon
public boolean isDaemon()Returntrue
if thread pool threads are daemons. The default istrue
.- Returns:
true
if thread pool threads are daemons.
-
setDaemon
Settrue
if thread pool threads are daemons. The default istrue
.- Parameters:
isDaemon
-true
if thread pool threads are daemons.- Returns:
- the
ThreadPoolConfig
with the daemon property set.
-
getMaxPoolSize
public int getMaxPoolSize()Get max thread pool size. The default isMath.max(Runtime.getRuntime().availableProcessors(), 20)
- Returns:
- max thread pool size.
-
setMaxPoolSize
Set max thread pool size. The default is The default isMath.max(Runtime.getRuntime().availableProcessors(), 20)
. Cannot be smaller than 3.- Parameters:
maxPoolSize
- the max thread pool size.- Returns:
- the
ThreadPoolConfig
with the new max pool size set.
-
getCorePoolSize
public int getCorePoolSize()Get the core thread pool size - the size of the thread pool will never bee smaller than this. The default is 1.- Returns:
- the core thread pool size - the size of the thread pool will never bee smaller than this.
-
setCorePoolSize
Set the core thread pool size - the size of the thread pool will never bee smaller than this. The default is 1.- Parameters:
corePoolSize
- the core thread pool size - the size of the thread pool will never bee smaller than this.- Returns:
- the
ThreadPoolConfig
with the new core pool size set.
-
getQueueLimit
public int getQueueLimit()Get the limit of the queue, where tasks are temporarily stored when all threads are busy. Value less than 0 means unlimited queue. The default is -1.- Returns:
- the thread-pool queue limit. The queue limit
-
setQueueLimit
Set the limit of the queue, where tasks are temporarily stored when all threads are busy. Value less than 0 means unlimited queue. The default is -1.- Parameters:
queueLimit
- the thread pool queue limit. The queueLimit value less than 0 means unlimited queue.- Returns:
- the
ThreadPoolConfig
with the new queue limit.
-
setKeepAliveTime
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 (seesetCorePoolSize(int)
,setMaxPoolSize(int)
) - then the thread will be terminated and removed from the thread pool. The default is 10s.- 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
Get 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 (seesetCorePoolSize(int)
,setMaxPoolSize(int)
) - then the thread will be terminated and removed from the thread pool. The default is 10s.- Returns:
- the keep-alive timeout, the value less than 0 means no timeout.
-
getInitialClassLoader
Get the class loader (if any) to be initially exposed by threads from this pool. If not specified, the class loader of the parent thread that initialized the pool will be used.- Returns:
- the class loader (if any) to be initially exposed by threads from this pool.
-
setInitialClassLoader
Specifies the context class loader that will be used by threads in this pool. If not specified, the class loader of the parent thread that initialized the pool will be used.- Parameters:
initialClassLoader
- the class loader to be exposed by threads of this pool.- Returns:
- the
ThreadPoolConfig
with the class loader set. - See Also:
-
toString
-
equals
-
hashCode
public int hashCode()
-