Module org.eclipse.jetty.util

Package org.eclipse.jetty.util.thread

Interface Invocable

All Known Subinterfaces:

Blocker.Callback, Blocker.Promise<C>, Blocker.Runnable, Callback, Callback.Completing, Invocable.Callable, Invocable.Task, Promise.Invocable<R>

All Known Implementing Classes:

Callback.Completable, Callback.Nested, CountingCallback, FutureCallback, Invocable.ReadyTask, Invocable.Task.Abstract, IteratingCallback, IteratingNestedCallback, Promise.Invocable.Abstract, Promise.Invocable.NonBlocking, SharedBlockingCallback.Blocker

public interface Invocable

A task (typically either a Runnable or Invocable.Callable that declares how it will behave when invoked:

• blocking, the invocation will certainly block (e.g. performs blocking I/O)
• non-blocking, the invocation will certainly not block
• either, the invocation may block

Static methods and are provided that allow the current thread to be tagged with a ThreadLocal to indicate if it has a blocking invocation type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Invocable.Callable
static enum	Invocable.InvocationType	The behavior of an Invocable task when it is called.
static class	Invocable.ReadyTask	A Runnable decorated with an Invocable.InvocationType.
static interface	Invocable.Task	A Runnable task with an Invocable.InvocationType.

Field Summary

Fields

Modifier and Type	Field	Description
static final ThreadLocal<Boolean>	__nonBlocking
static final Runnable	NOOP

Method Summary

Modifier and Type	Method	Description
static Runnable	combine(Runnable... runnables)	Combine Runnables into a single Runnable that sequentially calls the others.
static Invocable.InvocationType	combine(Invocable.InvocationType it1, Invocable.InvocationType it2)	Combine two invocation type.
static Invocable.InvocationType	combineTypes(Invocable.InvocationType... it)
static Invocable.Task	from(Invocable.InvocationType type, Runnable task)	Creates a Invocable.Task from the given InvocationType and Runnable.
default Invocable.InvocationType	getInvocationType()
static Invocable.InvocationType	getInvocationType(Object o)	Get the InvocationType of the given object.
static void	invokeNonBlocking(Runnable task)	Invoke a task with the calling thread, tagged to indicate that it will not block.
static boolean	isNonBlockingInvocation()	Tests if the current thread has been tagged as non-blocking.

Field Details

NOOP

static final Runnable NOOP

__nonBlocking

static final ThreadLocal<Boolean> __nonBlocking

Method Details

from

static Invocable.Task from(Invocable.InvocationType type,
 Runnable task)

Creates a Invocable.Task from the given InvocationType and Runnable.

Parameters:

type - the InvocationType

task - the Runnable

Returns:

a new Task

isNonBlockingInvocation

static boolean isNonBlockingInvocation()

Tests if the current thread has been tagged as non-blocking.

Returns:

True if the task the current thread is running has indicated that it will not block.

invokeNonBlocking

static void invokeNonBlocking(Runnable task)

Invoke a task with the calling thread, tagged to indicate that it will not block.

Parameters:

task - The task to invoke.

combine

static Invocable.InvocationType combine(Invocable.InvocationType it1,
 Invocable.InvocationType it2)

Combine two invocation type.

Parameters:

it1 - A type

it2 - Another type

Returns:

The combination of both type, where any tendency to block overrules any non-blocking.

combineTypes

static Invocable.InvocationType combineTypes(Invocable.InvocationType... it)

getInvocationType

static Invocable.InvocationType getInvocationType(Object o)

Get the InvocationType of the given object.

Parameters:

o - The object to check the invocation type of.

Returns:

If the object is an Invocable, it is coerced and the getInvocationType() used, otherwise Invocable.InvocationType.BLOCKING is returned.

getInvocationType

default Invocable.InvocationType getInvocationType()

Returns:

The InvocationType of this object

combine

static Runnable combine(Runnable... runnables)

Combine Runnables into a single Runnable that sequentially calls the others.

Parameters:

runnables - the Runnables to combine

Returns:

the combined Runnable with a combined Invocable.InvocationType.