Executors

callable

static fun callable(task: Runnable!): Callable<Any!>!

Returns a Callable object that, when called, runs the given task and returns null.

callable

static fun <T : Any!> callable(
    task: Runnable!, 
    result: T
): Callable<T>!

Returns a Callable object that, when called, runs the given task and returns the given result. This can be useful when applying methods requiring a Callable to an otherwise resultless action.

callable

static fun callable(action: PrivilegedAction<*>!): Callable<Any!>!

Returns a Callable object that, when called, runs the given privileged action and returns its result.

callable

static fun callable(action: PrivilegedExceptionAction<*>!): Callable<Any!>!

Returns a Callable object that, when called, runs the given privileged exception action and returns its result.

defaultThreadFactory

static fun defaultThreadFactory(): ThreadFactory!

Returns a default thread factory used to create new threads. This factory creates all new threads used by an Executor in the same ThreadGroup. It uses the group of the thread invoking this defaultThreadFactory method. Each new thread is created as a non-daemon thread with priority set to the smaller of Thread.NORM_PRIORITY and the maximum priority permitted in the thread group. New threads have names accessible via Thread.getName of pool-N-thread-M, where N is the sequence number of this factory, and M is the sequence number of the thread created by this factory.

newCachedThreadPool

static fun newCachedThreadPool(): ExecutorService!

Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available. These pools will typically improve the performance of programs that execute many short-lived asynchronous tasks. Calls to execute will reuse previously constructed threads if available. If no existing thread is available, a new thread will be created and added to the pool. Threads that have not been used for sixty seconds are terminated and removed from the cache. Thus, a pool that remains idle for long enough will not consume any resources. Note that pools with similar properties but different details (for example, timeout parameters) may be created using ThreadPoolExecutor constructors.

newCachedThreadPool

static fun newCachedThreadPool(threadFactory: ThreadFactory!): ExecutorService!

Creates a thread pool that creates new threads as needed, but will reuse previously constructed threads when they are available, and uses the provided ThreadFactory to create new threads when needed.

newFixedThreadPool

static fun newFixedThreadPool(nThreads: Int): ExecutorService!

Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue. At any point, at most nThreads threads will be active processing tasks. If additional tasks are submitted when all threads are active, they will wait in the queue until a thread is available. If any thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks. The threads in the pool will exist until it is explicitly shutdown.

newFixedThreadPool

static fun newFixedThreadPool(
    nThreads: Int, 
    threadFactory: ThreadFactory!
): ExecutorService!

Creates a thread pool that reuses a fixed number of threads operating off a shared unbounded queue, using the provided ThreadFactory to create new threads when needed. At any point, at most nThreads threads will be active processing tasks. If additional tasks are submitted when all threads are active, they will wait in the queue until a thread is available. If any thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks. The threads in the pool will exist until it is explicitly shutdown.

newScheduledThreadPool

static fun newScheduledThreadPool(corePoolSize: Int): ScheduledExecutorService!

Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.

newScheduledThreadPool

static fun newScheduledThreadPool(
    corePoolSize: Int, 
    threadFactory: ThreadFactory!
): ScheduledExecutorService!

Creates a thread pool that can schedule commands to run after a given delay, or to execute periodically.

newSingleThreadExecutor

static fun newSingleThreadExecutor(): ExecutorService!

Creates an Executor that uses a single worker thread operating off an unbounded queue. (Note however that if this single thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks.) Tasks are guaranteed to execute sequentially, and no more than one task will be active at any given time. Unlike the otherwise equivalent newFixedThreadPool(1) the returned executor is guaranteed not to be reconfigurable to use additional threads.

newSingleThreadExecutor

static fun newSingleThreadExecutor(threadFactory: ThreadFactory!): ExecutorService!

Creates an Executor that uses a single worker thread operating off an unbounded queue, and uses the provided ThreadFactory to create a new thread when needed. Unlike the otherwise equivalent newFixedThreadPool(1, threadFactory) the returned executor is guaranteed not to be reconfigurable to use additional threads.

newSingleThreadScheduledExecutor

static fun newSingleThreadScheduledExecutor(): ScheduledExecutorService!

Creates a single-threaded executor that can schedule commands to run after a given delay, or to execute periodically. (Note however that if this single thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks.) Tasks are guaranteed to execute sequentially, and no more than one task will be active at any given time. Unlike the otherwise equivalent newScheduledThreadPool(1) the returned executor is guaranteed not to be reconfigurable to use additional threads.

newSingleThreadScheduledExecutor

static fun newSingleThreadScheduledExecutor(threadFactory: ThreadFactory!): ScheduledExecutorService!

Creates a single-threaded executor that can schedule commands to run after a given delay, or to execute periodically. (Note however that if this single thread terminates due to a failure during execution prior to shutdown, a new one will take its place if needed to execute subsequent tasks.) Tasks are guaranteed to execute sequentially, and no more than one task will be active at any given time. Unlike the otherwise equivalent newScheduledThreadPool(1, threadFactory) the returned executor is guaranteed not to be reconfigurable to use additional threads.

newWorkStealingPool

static fun newWorkStealingPool(): ExecutorService!

Creates a work-stealing thread pool using the number of available processors as its target parallelism level.

newWorkStealingPool

static fun newWorkStealingPool(parallelism: Int): ExecutorService!

Creates a thread pool that maintains enough threads to support the given parallelism level, and may use multiple queues to reduce contention. The parallelism level corresponds to the maximum number of threads actively engaged in, or available to engage in, task processing. The actual number of threads may grow and shrink dynamically. A work-stealing pool makes no guarantees about the order in which submitted tasks are executed.

privilegedCallable

static fun <T : Any!> privilegedCallable(callable: Callable<T>!): Callable<T>!

Deprecated: This method originally returned a Callable object that when called, executed the given callable under the current access control context. Access control contexts were only useful in conjunction with the Security Manager, which is no longer supported. There is no replacement for the Security Manager or this method.

Legacy security code; do not use.

privilegedCallableUsingCurrentClassLoader

static fun <T : Any!> privilegedCallableUsingCurrentClassLoader(callable: Callable<T>!): Callable<T>!

Deprecated: This method originally returned a Callable object that when called, executed the given callable under the current access control context, with the current context class loader as the context class loader. Access control contexts were only useful in conjunction with the Security Manager, which is no longer supported. There is no replacement for the Security Manager or this method.

Legacy security code; do not use.

privilegedThreadFactory

static fun privilegedThreadFactory(): ThreadFactory!

Deprecated: This method originally returned a thread factory that created new threads that had the same access control context as the current thread. Access control contexts were only useful in conjunction with the Security Manager, which is no longer supported. There is no replacement for the Security Manager or this method.

Legacy security code; do not use.

unconfigurableExecutorService

static fun unconfigurableExecutorService(executor: ExecutorService!): ExecutorService!

Returns an object that delegates all defined ExecutorService methods to the given executor, but not any other methods that might otherwise be accessible using casts. This provides a way to safely "freeze" configuration and disallow tuning of a given concrete implementation.

unconfigurableScheduledExecutorService

static fun unconfigurableScheduledExecutorService(executor: ScheduledExecutorService!): ScheduledExecutorService!

Returns an object that delegates all defined ScheduledExecutorService methods to the given executor, but not any other methods that might otherwise be accessible using casts. This provides a way to safely "freeze" configuration and disallow tuning of a given concrete implementation.