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

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

Method Summary

Modifier and Type	Method and Description
public static Invocable.InvocationType	Returns: The combination of both type, where any tendency to block overrules any non blocking. combine(Invocable.InvocationType A type it1, Invocable.InvocationType Another type it2) Combine two invocation type.
public static Runnable	Returns: the combined `Runnable` with a combined `InvocationType`. combine(Runnable... the `Runnable`s to combine runnables) Combine `Runnable`s into a single `Runnable` that sequentially calls the others.
public static Invocable.Task	Returns: a new Task from(Invocable.InvocationType the InvocationType type, Runnable the Runnable task) Creates a `Task` from the given InvocationType and Runnable.
public static Invocable.InvocationType	Returns: If the object is an Invocable, it is coerced and the `getInvocationType()` used, otherwise `InvocationType#BLOCKING` is returned. getInvocationType(Object The object to check the invocation type of. o) Get the invocation type of an Object.
public default Invocable.InvocationType	Returns: The InvocationType of this object getInvocationType()
public static void	invokeNonBlocking(Runnable The task to invoke. task) Invoke a task with the calling thread, tagged to indicate that it will not block.
public static boolean	Returns: True if the task the current thread is running has indicated that it will not block. isNonBlockingInvocation() Test if the current thread has been tagged as non blocking

Field Detail

__nonBlocking	back to summary
public static final ThreadLocal<Boolean> __nonBlocking

NOOP	back to summary
public static final Runnable NOOP

Method Detail

combine	back to summary
public static Invocable.InvocationType combine(Invocable.InvocationType it1, Invocable.InvocationType it2) Combine two invocation type. Parameters it1:Invocable.InvocationType A type it2:Invocable.InvocationType Another type Returns:Invocable.InvocationType The combination of both type, where any tendency to block overrules any non blocking.

combine

back to summary

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

Combine two invocation type.

Parameters

it1:Invocable.InvocationType: A type
it2:Invocable.InvocationType: Another type

Returns:Invocable.InvocationType

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

combine back to summary

combine	back to summary
public static Runnable combine(Runnable... runnables) Combine `Runnable`s into a single `Runnable` that sequentially calls the others. Parameters runnables:Runnable[] the `Runnable`s to combine Returns:Runnable the combined `Runnable` with a combined `InvocationType`.

public static Runnable combine(Runnable... runnables)

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

Parameters

runnables:Runnable[]: the Runnables to combine

Returns:Runnable

the combined Runnable with a combined InvocationType.

from back to summary

from	back to summary
public static Invocable.Task from(Invocable.InvocationType type, Runnable task) Creates a `Task` from the given InvocationType and Runnable. Parameters type:Invocable.InvocationType the InvocationType task:Runnable the Runnable Returns:Invocable.Task a new Task

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

Creates a Task from the given InvocationType and Runnable.

Parameters

type:Invocable.InvocationType: the InvocationType
task:Runnable: the Runnable

Returns:Invocable.Task

a new Task

getInvocationType back to summary

getInvocationType	back to summary
public static Invocable.InvocationType getInvocationType(Object o) Get the invocation type of an Object. Parameters o:Object The object to check the invocation type of. Returns:Invocable.InvocationType If the object is an Invocable, it is coerced and the `getInvocationType()` used, otherwise `InvocationType#BLOCKING` is returned.

public static Invocable.InvocationType getInvocationType(Object o)

Get the invocation type of an Object.

Parameters

o:Object: The object to check the invocation type of.

Returns:Invocable.InvocationType

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

getInvocationType	back to summary
public default Invocable.InvocationType getInvocationType() Returns:Invocable.InvocationType The InvocationType of this object

invokeNonBlocking	back to summary
public static void invokeNonBlocking(Runnable task) Invoke a task with the calling thread, tagged to indicate that it will not block. Parameters task:Runnable The task to invoke.

invokeNonBlocking

back to summary

public static void invokeNonBlocking(Runnable task)

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

Parameters

task:Runnable: The task to invoke.

isNonBlockingInvocation	back to summary
public static boolean isNonBlockingInvocation() Test if the current thread has been tagged as non blocking Returns:boolean True if the task the current thread is running has indicated that it will not block.

isNonBlockingInvocation

back to summary

public static boolean isNonBlockingInvocation()

Test if the current thread has been tagged as non blocking

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

org.eclipse.jetty.util.thread back to summary

public Interface Invocable.Callable

extends Invocable

Field Summary

Inherited from org.eclipse.jetty.util.thread.Invocable:: __nonBlocking NOOP

Method Summary

Modifier and Type	Method and Description
public void	call()

Inherited from org.eclipse.jetty.util.thread.Invocable:: combine combine from getInvocationType getInvocationType invokeNonBlocking isNonBlockingInvocation

Method Detail

call	back to summary
public void call() throws Exception

org.eclipse.jetty.util.thread back to summary

public final Enum Invocable.InvocationType

Class Inheritance

extends Enum<Invocable.InvocationType>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.util.thread.Invocable.InvocationType

The behavior of an Invocable when it is invoked.

Typically, Runnables or org.eclipse.jetty.util.Callbacks declare their invocation type; this information is then used by the code that should invoke the Runnable or Callback to decide whether to invoke it directly, or submit it to a thread pool to be invoked by a different thread.

Field Summary

Modifier and Type	Field and Description
public static final Invocable.InvocationType	BLOCKING Invoking the `Invocable` may block the invoker thread, and the invocation may be performed immediately (possibly blocking the invoker thread) or deferred to a later time, for example by submitting the `Invocable` to a thread pool.
public static final Invocable.InvocationType	EITHER Invoking the `Invocable` may block the invoker thread, but the invocation cannot be deferred to a later time, differently from `BLOCKING`.
public static final Invocable.InvocationType	NON_BLOCKING Invoking the `Invocable` does not block the invoker thread, and the invocation may be performed immediately in the invoker thread.

Constructor Summary

Access	Constructor and Description
private	InvocationType()

Method Summary

Modifier and Type	Method and Description
public static Invocable.InvocationType	valueOf(String name)
public static Invocable.InvocationType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

BLOCKING back to summary

BLOCKING	back to summary
public static final Invocable.InvocationType BLOCKING Invoking the `Invocable` may block the invoker thread, and the invocation may be performed immediately (possibly blocking the invoker thread) or deferred to a later time, for example by submitting the `Invocable` to a thread pool. This invocation type is suitable for `Invocable`s that call application code, for example to process an HTTP request.

public static final Invocable.InvocationType BLOCKING

Invoking the Invocable may block the invoker thread, and the invocation may be performed immediately (possibly blocking the invoker thread) or deferred to a later time, for example by submitting the Invocable to a thread pool.

This invocation type is suitable for Invocables that call application code, for example to process an HTTP request.

EITHER back to summary

EITHER	back to summary
public static final Invocable.InvocationType EITHER Invoking the `Invocable` may block the invoker thread, but the invocation cannot be deferred to a later time, differently from `BLOCKING`. This invocation type is suitable for `Invocable`s that themselves perform the non-deferrable action in a non-blocking way, thus advancing a possibly stalled system.

public static final Invocable.InvocationType EITHER

Invoking the Invocable may block the invoker thread, but the invocation cannot be deferred to a later time, differently from BLOCKING.

This invocation type is suitable for Invocables that themselves perform the non-deferrable action in a non-blocking way, thus advancing a possibly stalled system.

NON_BLOCKING back to summary

NON_BLOCKING	back to summary
public static final Invocable.InvocationType NON_BLOCKING Invoking the `Invocable` does not block the invoker thread, and the invocation may be performed immediately in the invoker thread. This invocation type is suitable for `Invocable`s that call implementation code that is guaranteed to never block the invoker thread.

public static final Invocable.InvocationType NON_BLOCKING

Invoking the Invocable does not block the invoker thread, and the invocation may be performed immediately in the invoker thread.

This invocation type is suitable for Invocables that call implementation code that is guaranteed to never block the invoker thread.

Constructor Detail

InvocationType	back to summary
private InvocationType()

Method Detail

valueOf	back to summary
public static Invocable.InvocationType valueOf(String name)

values	back to summary
public static Invocable.InvocationType[] values()

org.eclipse.jetty.util.thread back to summary

public Class Invocable.ReadyTask

Class Inheritance

extends Object
implements Task

java.lang.Object
org.eclipse.jetty.util.thread.Invocable.ReadyTask

All Implemented Interfaces

org.eclipse.jetty.util.thread.Invocable.Task, java.lang.Runnable, org.eclipse.jetty.util.thread.Invocable

A Runnable decorated with an InvocationType.

Field Summary

Modifier and Type	Field and Description
private final Runnable	task
private final Invocable.InvocationType	type

Constructor Summary

Access	Constructor and Description
public	ReadyTask(Invocable.InvocationType type, Runnable task)

Method Summary

Modifier and Type	Method and Description
public Invocable.InvocationType	getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

task	back to summary
private final Runnable task

type	back to summary
private final Invocable.InvocationType type

Constructor Detail

ReadyTask	back to summary
public ReadyTask(Invocable.InvocationType type, Runnable task)

Method Detail

getInvocationType	back to summary
public Invocable.InvocationType getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType. Returns:Invocable.InvocationType Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType. The InvocationType of this object Annotations @Override

getInvocationType

back to summary

public Invocable.InvocationType getInvocationType()

Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.

Returns:Invocable.InvocationType

Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType.

The InvocationType of this object

Annotations

@Override

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Interface Invocable

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Interface Invocable.Callable

Field Summary

Method Summary

Method Detail

public final Enum Invocable.InvocationType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Invocable.ReadyTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Invocable.Task

Field Summary

Method Summary