fixed : By default it will build one with 20 threads on it. Great for multiple task execution and worker processing.
Fixed Thread
single : A great way to control that submitted tasks will execute in the order of submission much like a FIFO queue (First In First Out).
Single Thread
cached : An unbounded pool where the number of threads will grow according to the tasks it needs to service. The threads are killed by a default 60 second timeout if not used and the pool shrinks back to 0.
Cached Executor
scheduled : A pool to use for scheduled tasks that can run one time or periodically. The default scheduled task queue has 20 threads for processing.
Scheduled Executor
Please note that each executor is unique in its way of operation, so make sure you read about each type in the JavaDocs or watch this amazing video: https://www.youtube.com/watch?v=sIkG0X4fqs4​
Executor Methods
Here are the methods you can use for registering and managing singleton executors in your application:
newExecutor() : Create and register an executor according to passed arguments. If the executor exists, just return it.
newScheduledExecutor() : Create a scheduled executor according to passed arguments. Shortcut to newExecutor( type: "scheduled" )
newSingleExecutor() : Create a single thread executor. Shortcut to newExecutor( type: "single", threads: 1 )
newCachedExecutor() : Create a cached thread executor. Shortcut to newExecutor( type: "cached" )
getExecutor() : Get a registered executor registerd in this async manager
getExecutorNames() : Get the array of registered executors in the system
hasExecutor() : Verify if an executor exists
deleteExecutor() : Delete an executor from the registry, if the executor has not shutdown, it will shutdown the executor for you using the shutdownNow() event
shutdownExecutor() : Shutdown an executor or force it to shutdown, you can also do this from the Executor themselves. If an un-registered executor name is passed, it will ignore it
shutdownAllExecutors() : Shutdown all registered executors in the system
getExecutorStatusMap() : Returns a structure of status maps for every registered executor in the manager. This is composed of tons of stats about the executor.
And here are the full signatures:
1
/**
2
* Creates and registers an Executor according to the passed name, type and options.
3
* The allowed types are: fixed, cached, single, scheduled with fixed being the default.
4
*
5
* You can then use this executor object to submit tasks for execution and if it's a
6
* scheduled executor then actually execute scheduled tasks.
7
*
8
* Types of Executors:
9
* - fixed : By default it will build one with 20 threads on it. Great for multiple task execution and worker processing
10
* - single : A great way to control that submitted tasks will execute in the order of submission: FIFO
11
* - cached : An unbounded pool where the number of threads will grow according to the tasks it needs to service. The threads are killed by a default 60 second timeout if not used and the pool shrinks back
12
* - scheduled : A pool to use for scheduled tasks that can run one time or periodically
* Shutdown an executor or force it to shutdown, you can also do this from the Executor themselves.
95
* If an un-registered executor name is passed, it will ignore it
96
*
97
* @force Use the shutdownNow() instead of the shutdown() method
98
*/
99
AsyncManager functionshutdownExecutor(required name, boolean force =false)
100
​
101
/**
102
* Shutdown all registered executors in the system
103
*
104
* @force By default (false) it gracefullly shuts them down, else uses the shutdownNow() methods
105
*
106
* @return AsyncManager
107
*/
108
AsyncManager functionshutdownAllExecutors(boolean force =false)
109
​
110
/**
111
* Returns a structure of status maps for every registered executor in the
112
* manager. This is composed of tons of stats about the executor
113
*
114
* @name The name of the executor to retrieve th status map ONLY!
115
*
116
* @return A struct of metadata about the executor or all executors
117
*/
118
struct functiongetExecutorStatusMap(name)
Copied!
Single Use Executors
If you just want to use executors for different completion stages and then discard them, you can easily do so by using the $executors public component in the AsyncManager. This object can be found at: coldbox.system.async.util.Executors:
1
asyncManager.$executors.{creationMethod}()
Copied!
The available creation methods are:
1
this.DEFAULT_THREADS=20;
2
/**
3
* Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue.
// Create two types of thread pools: 1) CPU intesive, 2) IO Intensive
8
var cpuBound = asyncManager.$executors.newFixedThreadPool(4);
9
var ioBound = asyncManager.$executors.newFixedThreadPool(50);
10
​
11
// Process an order with different executor pools
12
newFuture(()=> orderService.getOrder(), ioBound )
13
.thenAsync((order)=>enrichOrder( order ), cpuBound )
14
.thenAsync((order)=>performPayment( order ), ioBound )
15
.thenAsync((order)=>dispatchOrder( order ), cpuBound )
16
.thenAsync((order)=>sendConfirmation( order ), ioBound );
Copied!
ColdBox Task Scheduler
Every ColdBox application will register a task scheduler called coldbox-tasks which ColdBox internal services can leverage it for tasks and schedules. It is configured with 20 threads and using the scheduled type. You can leverage if you wanted to for your own tasks as well.