Module org.eclipse.jetty.util

Package org.eclipse.jetty.util.thread

Interface Invocable

All Known Subinterfaces:

Callback, Invocable.Task

All Known Implementing Classes:

Callback.Completable, Callback.Completing, Callback.Nested, CountingCallback, FutureCallback, Invocable.ReadyTask, IteratingCallback, IteratingNestedCallback, SharedBlockingCallback.Blocker

public interface Invocable

A task (typically either a Runnable or 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 enum	Invocable.InvocationType	The behavior of an Invocable when it is invoked.
static class	Invocable.ReadyTask	A Runnable decorated with an Invocable.InvocationType.
static interface	Invocable.Task	A task with an Invocable.InvocationType.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static Invocable.InvocationType	combine(Invocable.InvocationType it1, Invocable.InvocationType it2)
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 invocation type of an Object.
static void	invokeNonBlocking(Runnable task)	Invoke a task with the calling thread, tagged to indicate that it will not block.
static boolean	isNonBlockingInvocation()	Test if the current thread has been tagged as non blocking

Field Details

__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()

Test 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)

getInvocationType

static Invocable.InvocationType getInvocationType(Object o)

Get the invocation type of an 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