Top Description Inners Fields Constructors Methods
org.eclipse.jetty.util.thread

public Class SerializedInvoker

extends Object
Class Inheritance
Imports
java.util.concurrent.atomic.AtomicReference, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.slf4j.Logger, .LoggerFactory
Ensures serial invocation of submitted tasks.

The InvocationType of the Runnable returned from this class is always InvocationType#BLOCKING since a blocking task may be added to the queue at any time.

This class was inspired by the public domain class NonBlockingMutexExecutor

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
SerializedInvoker.Link

private static record
SerializedInvoker.NamedRunnable

Field Summary

Modifier and TypeField and Description
private final AtomicReference<SerializedInvoker.Link>
_tail

private static final Logger
LOG

Constructor Summary

AccessConstructor and Description
public
SerializedInvoker()

Method Summary

Modifier and TypeMethod and Description
protected String
deriveTaskName(Runnable task)

public Runnable

Returns:

A Runnable that must be called to invoke the passed task and possibly other tasks. Null if the task will be invoked by another caller.
offer(Runnable
The task to invoke
task)

Arrange for a task to be invoked, mutually excluded from other tasks.

public Runnable

Returns:

A Runnable that must be called to invoke the passed tasks and possibly other tasks. Null if the tasks will be invoked by another caller.
offer(Runnable...
The tasks to invoke
tasks)

Arrange for tasks to be invoked, mutually excluded from other tasks.

protected void
onError(Runnable task, Throwable t)

public void
run(Runnable
The task to invoke
task)

Arrange for a task to be run, mutually excluded from other tasks.

public void
run(Runnable...
The tasks to invoke
tasks)

Arrange for tasks to be executed, mutually excluded from other tasks.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

_tailback to summary
private final AtomicReference<SerializedInvoker.Link> _tail
LOGback to summary
private static final Logger LOG

Constructor Detail

SerializedInvokerback to summary
public SerializedInvoker()

Method Detail

deriveTaskNameback to summary
protected String deriveTaskName(Runnable task)
offerback to summary
public Runnable offer(Runnable task)

Arrange for a task to be invoked, mutually excluded from other tasks.

Parameters
task:Runnable

The task to invoke

Returns:Runnable

A Runnable that must be called to invoke the passed task and possibly other tasks. Null if the task will be invoked by another caller.

offerback to summary
public Runnable offer(Runnable... tasks)

Arrange for tasks to be invoked, mutually excluded from other tasks.

Parameters
tasks:Runnable[]

The tasks to invoke

Returns:Runnable

A Runnable that must be called to invoke the passed tasks and possibly other tasks. Null if the tasks will be invoked by another caller.

onErrorback to summary
protected void onError(Runnable task, Throwable t)
runback to summary
public void run(Runnable task)

Arrange for a task to be run, mutually excluded from other tasks. This is equivalent to directly running any Runnable returned from offer(Runnable)

Parameters
task:Runnable

The task to invoke

runback to summary
public void run(Runnable... tasks)

Arrange for tasks to be executed, mutually excluded from other tasks. This is equivalent to directly running any Runnable returned from offer(Runnable...)

Parameters
tasks:Runnable[]

The tasks to invoke

toStringback 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
org.eclipse.jetty.util.thread back to summary

private final Record SerializedInvoker.NamedRunnable

extends Record
implements Runnable
Class Inheritance
All Implemented Interfaces
java.lang.Runnable
Record Components
delegate:Runnable 
name:String 

Field Summary

Modifier and TypeField and Description
private final Runnable
delegate

Record Component accessed by delegate().

private static final Logger
LOG

private final String
name

Record Component accessed by name().

Constructor Summary

AccessConstructor and Description
private
NamedRunnable(Runnable delegate, String name)

Method Summary

Modifier and TypeMethod and Description
public Runnable
delegate()

Record Component getter of delegate.

public final boolean
equals(Object
the reference object with which to compare.
o)

Implements abstract java.lang.Record.equals.

Indicates whether some other object is "equal to" this one.
public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.
public String
name()

Record Component getter of name.

public void
run()

Implements java.lang.Runnable.run.

Runs this operation.
public String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

delegateback to summary
private final Runnable delegate

Record Component accessed by delegate().

LOGback to summary
private static final Logger LOG
nameback to summary
private final String name

Record Component accessed by name().

Constructor Detail

NamedRunnableback to summary
private NamedRunnable(Runnable delegate, String name)

Method Detail

delegateback to summary
public Runnable delegate()

Record Component getter of delegate.

equalsback to summary
public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: 

    R copy = new R(r.c1(), r.c2(), ..., r.cn());
then it must be the case that r.equals(copy).
Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCodeback to summary
public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int

a hash code value for this record.

nameback to summary
public String name()

Record Component getter of name.

runback to summary
public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations
@Override
toStringback to summary
public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.

Annotations
@Override