Package com.glitchybyte.glib.concurrent

Interface GTaskRunner

All Superinterfaces:

Executor

All Known Implementing Classes:

GTaskRunnerService

public interface GTaskRunner
extends Executor

A task runner facility to run GTask tasks.

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

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.

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 interface java.util.concurrent.Executor

execute

Method Details

run

CompletableFuture<Void> run(Runnable runnable)
                     throws RejectedExecutionException

Submits a Runnable to execute concurrently.

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

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

Submits a collection of Runnable to execute concurrently.

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

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

Submits an array of Runnable to execute concurrently.

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

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

Submits a Callable to execute concurrently.

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

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

Submits a collection of Callable to execute concurrently.

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

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

Submits an array of Callable to execute concurrently.

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

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

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.

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

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

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.

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.