org.mule.runtime.api.scheduler

Interface SchedulerService

All Superinterfaces:

NamedObject, Service, SplashMessageProvider

@NoImplement
public interface SchedulerService
extends Service

Provides access to the different schedulers and thread pools that exist in the Mule runtime, allowing an artifact to schedule tasks on those.

This interface provides access to different schedulers, each with its own configured tuning options, optimized for some specific kind of work. Artifacts that need to dispatch tasks need to carefully determine which scheduler best fits the nature of the task in order to keep the resources usage and the impact on other artifacts at a minimum.

The Schedulers returned by methods in the implementations must provide access the the thread pools in the Mule Runtime that have the expected tuning configuration. Each Scheduler will have its own lifecycle, managed by its user and NOT this service.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
Scheduler	cpuIntensiveScheduler() Builds a fresh Scheduler with a default configuration for heavy computation or CPU intensive tasks.
Scheduler	cpuIntensiveScheduler(SchedulerConfig config) Builds a fresh Scheduler for heavy computation or CPU intensive tasks.
Scheduler	cpuIntensiveScheduler(SchedulerConfig config, SchedulerPoolsConfigFactory poolsConfigFactory) Builds a fresh Scheduler for heavy computation or CPU intensive tasks.
Scheduler	cpuLightScheduler() Builds a fresh Scheduler with a default configuration for light CPU tasks.
Scheduler	cpuLightScheduler(SchedulerConfig config) Builds a fresh Scheduler for light CPU tasks.
Scheduler	cpuLightScheduler(SchedulerConfig config, SchedulerPoolsConfigFactory poolsConfigFactory) Builds a fresh Scheduler for light CPU tasks.
Scheduler	customScheduler(SchedulerConfig config) Builds a fresh Scheduler for custom tasks.
Scheduler	customScheduler(SchedulerConfig config, int queueSize) Builds a fresh Scheduler for custom tasks.
List<SchedulerView>	getSchedulers() Provides a read-only view of all currently active Schedulers created through this service.
Scheduler	ioScheduler() Builds a fresh Scheduler with a default configuration for blocking I/O tasks.
Scheduler	ioScheduler(SchedulerConfig config) Builds a fresh Scheduler for blocking I/O tasks.
Scheduler	ioScheduler(SchedulerConfig config, SchedulerPoolsConfigFactory poolsConfigFactory) Builds a fresh Scheduler for blocking I/O tasks.
default boolean	isCurrentThreadForCpuWork() Determines if the current thread may be locked.
default boolean	isCurrentThreadForCpuWork(SchedulerPoolsConfigFactory poolsConfigFactory) Determines if the current thread may be locked.

Methods inherited from interface org.mule.runtime.api.service.Service

getContractName, getSplashMessage

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

cpuLightScheduler

Scheduler cpuLightScheduler()

Builds a fresh Scheduler with a default configuration for light CPU tasks. The returned Scheduler is backed by the Mule runtime cpu-light executor, which is shared by all Schedulers returned by this method.

A task is considered cpu-light if it doesn't block at any time and its duration is less than 10 milliseconds.

Implementations must get the appropriate config from the runtime context to build the target Scheduler. This method must act only as a delegate of cpuLightScheduler(SchedulerConfig, SchedulerPoolsConfigFactory).

Returns:

a scheduler that runs cpu-light tasks.

ioScheduler

Scheduler ioScheduler()

Builds a fresh Scheduler with a default configuration for blocking I/O tasks. The returned Scheduler is backed by the Mule runtime blocking I/O executor, which is shared by all Schedulers returned by this method.

A task is considered blocking I/O if it spends most of it's clock duration blocked due to I/O operations.

Implementations must get the appropriate config from the runtime context to build the target Scheduler. This method must act only as a delegate of ioScheduler(SchedulerConfig, SchedulerPoolsConfigFactory).

Returns:

a scheduler that runs blocking I/O tasks.

cpuIntensiveScheduler

Scheduler cpuIntensiveScheduler()

Builds a fresh Scheduler with a default configuration for heavy computation or CPU intensive tasks. The returned Scheduler is backed by the Mule runtime computation executor, which is shared by all Schedulers returned by this method.

A task is considered a CPU intensive if its duration is more than 10 milliseconds and less than 20% of its clock time is due to blocking.

Implementations must get the appropriate config from the runtime context to build the target Scheduler. This method must act only as a delegate of cpuIntensiveScheduler(SchedulerConfig, SchedulerPoolsConfigFactory).

Returns:

a scheduler that runs CPU intensive tasks.

cpuLightScheduler

Scheduler cpuLightScheduler(SchedulerConfig config)

Builds a fresh Scheduler for light CPU tasks. The returned Scheduler is backed by the Mule runtime cpu-light executor, which is shared by all Schedulers returned by this method.

A task is considered cpu-light if it doesn't block at any time and its duration is less than 10 milliseconds.

If the provided config has maxConcurrentTasks set, exceeding tasks will block the caller, until a running task is finished.

Parameters:

config - allows customization of the returned scheduler.

Returns:

a scheduler that runs cpu-light tasks.

ioScheduler

Scheduler ioScheduler(SchedulerConfig config)

Builds a fresh Scheduler for blocking I/O tasks. The returned Scheduler is backed by the Mule runtime blocking I/O executor, which is shared by all Schedulers returned by this method.

A task is considered blocking I/O if it spends most of it's clock duration blocked due to I/O operations.

If the provided config has maxConcurrentTasks set, exceeding tasks will block the caller, until a running task is finished.

Parameters:

config - allows customization of the returned scheduler.

Returns:

a scheduler that runs blocking I/O tasks.

cpuIntensiveScheduler

Scheduler cpuIntensiveScheduler(SchedulerConfig config)

Builds a fresh Scheduler for heavy computation or CPU intensive tasks. The returned Scheduler is backed by the Mule runtime computation executor, which is shared by all Schedulers returned by this method.

A task is considered a CPU intensive if its duration is more than 10 milliseconds and less than 20% of its clock time is due to blocking.

If the provided config has maxConcurrentTasks set, exceeding tasks will block the caller, until a running task is finished.

Parameters:

config - allows customization of the returned scheduler.

Returns:

a scheduler that runs CPU intensive tasks.

cpuLightScheduler

Scheduler cpuLightScheduler(SchedulerConfig config,
                            SchedulerPoolsConfigFactory poolsConfigFactory)

Builds a fresh Scheduler for light CPU tasks. The returned Scheduler is backed by the Mule runtime cpu-light executor, which is shared by all Schedulers returned by this method.

A task is considered cpu-light if it doesn't block at any time and its duration is less than 10 milliseconds.

If the provided config has maxConcurrentTasks set, exceeding tasks will block the caller, until a running task is finished.

Parameters:

config - allows customization of the returned scheduler.

poolsConfigFactory - the configuration to use for the thread pools that the schedulers use.

Returns:

a scheduler that runs cpu-light tasks.

ioScheduler

Scheduler ioScheduler(SchedulerConfig config,
                      SchedulerPoolsConfigFactory poolsConfigFactory)

Builds a fresh Scheduler for blocking I/O tasks. The returned Scheduler is backed by the Mule runtime blocking I/O executor, which is shared by all Schedulers returned by this method.

A task is considered blocking I/O if it spends most of it's clock duration blocked due to I/O operations.

If the provided config has maxConcurrentTasks set, exceeding tasks will block the caller, until a running task is finished.

Parameters:

config - allows customization of the returned scheduler.

poolsConfigFactory - the configuration to use for the thread pools that the schedulers use.

Returns:

a scheduler that runs blocking I/O tasks.

cpuIntensiveScheduler

Scheduler cpuIntensiveScheduler(SchedulerConfig config,
                                SchedulerPoolsConfigFactory poolsConfigFactory)

Builds a fresh Scheduler for heavy computation or CPU intensive tasks. The returned Scheduler is backed by the Mule runtime computation executor, which is shared by all Schedulers returned by this method.

A task is considered a CPU intensive if its duration is more than 10 milliseconds and less than 20% of its clock time is due to blocking.

If the provided config has maxConcurrentTasks set, exceeding tasks will block the caller, until a running task is finished.

Parameters:

config - allows customization of the returned scheduler.

poolsConfigFactory - the configuration to use for the thread pools that the schedulers use.

Returns:

a scheduler that runs CPU intensive tasks.

customScheduler

Scheduler customScheduler(SchedulerConfig config)

Builds a fresh Scheduler for custom tasks. The returned Scheduler is backed by an ExecutorService built with the given corePoolSize threads and a SynchronousQueue.

Parameters:

config - allows customization of the returned scheduler.

Returns:

a scheduler whose threads manage custom tasks.

customScheduler

Scheduler customScheduler(SchedulerConfig config,
                          int queueSize)

Builds a fresh Scheduler for custom tasks. The returned Scheduler is backed by an ExecutorService built with the given corePoolSize threads and a LinkedBlockingQueue with the given queueSize.

Parameters:

config - allows customization of the returned scheduler.

Returns:

a scheduler whose threads manage custom tasks.

isCurrentThreadForCpuWork

default boolean isCurrentThreadForCpuWork()

Determines if the current thread may be locked.

Returns:

whether Thread.currentThread() belongs to a ThreadGroup indication that waiting/blocking is allowed.

isCurrentThreadForCpuWork

default boolean isCurrentThreadForCpuWork(SchedulerPoolsConfigFactory poolsConfigFactory)

Determines if the current thread may be locked.

Parameters:

poolsConfigFactory - the configuration to use for the thread pools that the schedulers use.

Returns:

whether Thread.currentThread() belongs to a ThreadGroup indication that waiting/blocking is allowed.

getSchedulers

List<SchedulerView> getSchedulers()

Provides a read-only view of all currently active Schedulers created through this service.

Returns:

a List of SchedulerViews for all currently active Schedulers.