io.atomix.catalyst.concurrent

Interface ThreadContext

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SingleThreadContext, ThreadPoolContext

public interface ThreadContext
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(ThreadContext). 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 ThreadContext implementation.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
void	block() Sets the context state to blocked.
default void	checkThread() Checks that the current thread is the correct context thread.
void	close() Closes the context.
static ThreadContext	currentContext() Returns the current thread context.
static ThreadContext	currentContextOrThrow()
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.
boolean	isBlocked() Returns a boolean indicating whether the context state is blocked.
default boolean	isCurrentContext() Returns a boolean indicating whether the current thread is in this context.
org.slf4j.Logger	logger() Returns the context logger.
Scheduled	schedule(Duration initialDelay, Duration interval, Runnable callback) Schedules a runnable at a fixed rate on the context.
Scheduled	schedule(Duration delay, Runnable callback) Schedules a runnable on the context.
Serializer	serializer() Returns the context serializer.
void	unblock() Sets the context state to unblocked.

Method Detail

currentContext

static ThreadContext currentContext()

Returns the current thread context.

Returns:

The current thread context or null if no context exists.

currentContextOrThrow

static ThreadContext currentContextOrThrow()

Throws:

IllegalStateException - if the current thread is not a catalyst thread

isCurrentContext

default boolean isCurrentContext()

Returns a boolean indicating whether the current thread is in this context.

Returns:

Indicates whether the current thread is in this context.

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.

isBlocked

boolean isBlocked()

Returns a boolean indicating whether the context state is blocked.

Returns:

Indicates whether the context state is blocked.

block

void block()

Sets the context state to blocked.

unblock

void unblock()

Sets the context state to unblocked.

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(Duration delay,
                   Runnable callback)

Schedules a runnable on the context.

Parameters:

callback - The callback to schedule.

delay - The delay at which to schedule the runnable.

schedule

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

Schedules a runnable at a fixed rate on the context.

Parameters:

callback - The callback to schedule.

close

void close()

Closes the context.

Specified by:

close in interface AutoCloseable