Package com.glitchybyte.glib.concurrent

Class GTaskRunnerService

java.lang.Object

com.glitchybyte.glib.concurrent.GTaskExecutorService<ExecutorService>

com.glitchybyte.glib.concurrent.GTaskRunnerService

All Implemented Interfaces:

GTaskRunner, AutoCloseable, Executor

public final class GTaskRunnerService
extends GTaskExecutorService<ExecutorService>
implements GTaskRunner

A task runner facility to run GTask tasks.

Classes ending in 'Task' in the concurrent package must be started with a GTaskRunnerService.

This runner is also capable of running standalone Runnables and Callables. This avoids having to create, or keep track of, a separate ExecutorService. Keep in mind this class uses platform threads.

Field Summary

Fields inherited from class com.glitchybyte.glib.concurrent.GTaskExecutorService

runner

Constructor Summary

Constructors

Constructor	Description
GTaskRunnerService()	Creates a task runner with an unbounded cached thread pool.
GTaskRunnerService(Integer threadCount)	Creates a task runner with a fixed thread pool.

Method Summary

Modifier and Type	Method	Description
<V> CompletableFuture<V>	call(Callable<V> callable)	Submits a Callable to execute concurrently.
<V> List<CompletableFuture<V>>	callAll(Collection<Callable<V>> callables)	Submits a collection of Callable to execute concurrently.
<V> List<CompletableFuture<V>>	callAll(Callable<V>[] callables)	Submits an array of Callable to execute concurrently.
CompletableFuture<Void>	run(Runnable runnable)	Submits a Runnable to execute concurrently.
List<CompletableFuture<Void>>	runAll(Runnable[] runnables)	Submits an array of Runnable to execute concurrently.
List<CompletableFuture<Void>>	runAll(Collection<Runnable> runnables)	Submits a collection of Runnable to execute concurrently.
<T extends GTask> T	start(T task)	Submits a task to be run concurrently.
<T extends GTask> T	start(T task, Duration timeout)	Submits a task to execute concurrently.

Methods inherited from class com.glitchybyte.glib.concurrent.GTaskExecutorService

close, createTaskWrapper, execute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.concurrent.Executor

execute

Constructor Details

GTaskRunnerService

public GTaskRunnerService()

Creates a task runner with an unbounded cached thread pool.

GTaskRunnerService

public GTaskRunnerService(Integer threadCount)

Creates a task runner with a fixed thread pool.

Parameters:

threadCount - Thread count for this runner.

Method Details

run

public CompletableFuture<Void> run(Runnable runnable)
                            throws RejectedExecutionException

Description copied from interface: GTaskRunner

Submits a Runnable to execute concurrently.

Specified by:

run in interface GTaskRunner

Parameters:

runnable - A Runnable to execute.

Returns:

A CompletableFuture<Void> representing pending completion of the task.

Throws:

RejectedExecutionException - If the task cannot be scheduled for execution.

runAll

public List<CompletableFuture<Void>> runAll(Collection<Runnable> runnables)
                                     throws RejectedExecutionException

Description copied from interface: GTaskRunner

Submits a collection of Runnable to execute concurrently.

Specified by:

runAll in interface GTaskRunner

Parameters:

runnables - A collection of Runnable to execute.

Returns:

A list of CompletableFuture<Void> representing pending completion of the tasks.

Throws:

RejectedExecutionException - If one the tasks cannot be scheduled for execution.

runAll

public List<CompletableFuture<Void>> runAll(Runnable[] runnables)
                                     throws RejectedExecutionException

Description copied from interface: GTaskRunner

Submits an array of Runnable to execute concurrently.

Specified by:

runAll in interface GTaskRunner

Parameters:

runnables - An array of Runnable to execute.

Returns:

A list of CompletableFuture<Void> representing pending completion of the tasks.

Throws:

RejectedExecutionException - If one the tasks cannot be scheduled for execution.

call

public <V> CompletableFuture<V> call(Callable<V> callable)
                              throws RejectedExecutionException

Description copied from interface: GTaskRunner

Submits a Callable to execute concurrently.

Specified by:

call in interface GTaskRunner

Type Parameters:

V - Type of task result.

Parameters:

callable - A Callable to execute.

Returns:

A CompletableFuture representing pending completion of the task.

Throws:

RejectedExecutionException - If the task cannot be scheduled for execution.

callAll

public <V> List<CompletableFuture<V>> callAll(Collection<Callable<V>> callables)
                                       throws RejectedExecutionException

Description copied from interface: GTaskRunner

Submits a collection of Callable to execute concurrently.

Specified by:

callAll in interface GTaskRunner

Type Parameters:

V - Type of task result.

Parameters:

callables - A collection of Callable to execute.

Returns:

A list of CompletableFuture representing pending completion of the tasks.

Throws:

RejectedExecutionException - If one of the tasks cannot be scheduled for execution.

callAll

public <V> List<CompletableFuture<V>> callAll(Callable<V>[] callables)
                                       throws RejectedExecutionException

Description copied from interface: GTaskRunner

Submits an array of Callable to execute concurrently.

Specified by:

callAll in interface GTaskRunner

Type Parameters:

V - Type of task result.

Parameters:

callables - An array of Callable to execute.

Returns:

A list of CompletableFuture representing pending completion of the tasks.

Throws:

RejectedExecutionException - If one the tasks cannot be scheduled for execution.

start

public <T extends GTask> T start(T task,
 Duration timeout)
                          throws InterruptedException,
RejectedExecutionException

Description copied from interface: GTaskRunner

Submits a task to execute concurrently.

If the task does not start within the given timeout, an IllegalStateException will be raised as this is considered a bug in the task implementation.

This method blocks until the task has started.

Specified by:

start in interface GTaskRunner

Type Parameters:

T - Task type.

Parameters:

task - Task to start.

timeout - Time given to the task to start.

Returns:

The started task.

Throws:

InterruptedException - If the thread is interrupted while waiting for the task to start.

RejectedExecutionException - If the task cannot be scheduled for execution.

start

public <T extends GTask> T start(T task)
                          throws InterruptedException,
RejectedExecutionException

Description copied from interface: GTaskRunner

Submits a task to be run concurrently.

If the task does not start within 5 seconds, an IllegalStateException will be raised as this is considered a bug in the task implementation.

This method blocks until the task has started.

Specified by:

start in interface GTaskRunner

Type Parameters:

T - Task type.

Parameters:

task - Task to start.

Returns:

The started task.

Throws:

InterruptedException - If the thread is interrupted while waiting for the task to start.

RejectedExecutionException - If the task cannot be scheduled for execution.