net.kuujo.catalyst.util.concurrent

Interface Context

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SingleThreadContext, ThreadPoolContext

public interface Context
extends AutoCloseable

Thread context.

The thread context is used by Catalyst to determine the correct thread on which to execute asynchronous callbacks. All threads created within Catalyst must be instances of CatalystThread. Once a thread has been created, the context is stored in the thread object via CatalystThread.setContext(Context). This means there is a one-to-one relationship between a context and a thread. That is, a context is representative of a thread and provides an interface for firing events on that thread.

In addition to serving as an Executor, the context also provides thread-local storage for Serializer serializer instances. All serialization that takes place within a CatalystThread should use the context serializer().

Components of the framework that provide custom threads should use CatalystThreadFactory to allocate new threads and provide a custom Context implementation.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
default void	checkThread() Checks that the current thread is the correct context thread.
void	close() Closes the context.
static Context	currentContext() Returns the current thread context.
default CompletableFuture<Void>	execute(Runnable callback) Executes a callback on the context.
default <T> CompletableFuture<T>	execute(Supplier<T> callback) Executes a callback on the context.
Executor	executor() Returns the underlying executor.
org.slf4j.Logger	logger() Returns the context logger.
Scheduled	schedule(Runnable callback, Duration delay) Schedules a runnable on the context.
Scheduled	schedule(Runnable callback, Duration initialDelay, Duration interval) Schedules a runnable at a fixed rate on the context.
Serializer	serializer() Returns the context serializer.

Method Detail

currentContext

static Context currentContext()

Returns the current thread context.

Returns:

The current thread context or null if no context exists.

checkThread

default void checkThread()

Checks that the current thread is the correct context thread.

logger

org.slf4j.Logger logger()

Returns the context logger.

Returns:

The context logger.

serializer

Serializer serializer()

Returns the context serializer.

Returns:

The context serializer.

executor

Executor executor()

Returns the underlying executor.

Returns:

The underlying executor.

execute

default CompletableFuture<Void> execute(Runnable callback)

Executes a callback on the context.

Parameters:

callback - The callback to execute.

Returns:

A completable future to be completed once the callback has been executed.

execute

default <T> CompletableFuture<T> execute(Supplier<T> callback)

Executes a callback on the context.

Type Parameters:

T - The callback result type.

Parameters:

callback - The callback to execute.

Returns:

A completable future to be completed with the callback result.

schedule

Scheduled schedule(Runnable callback,
                   Duration delay)

Schedules a runnable on the context.

Parameters:

callback - The callback to schedule.

delay - The delay at which to schedule the runnable.

schedule

Scheduled schedule(Runnable callback,
                   Duration initialDelay,
                   Duration interval)

Schedules a runnable at a fixed rate on the context.

Parameters:

callback - The callback to schedule.

initialDelay - The delay at which to schedule the runnable.

interval - The interval at which to run the task.

close

void close()

Closes the context.

Specified by:

close in interface AutoCloseable