io.servicetalk.concurrent.api.internal

Class OffloaderAwareExecutor

java.lang.Object

io.servicetalk.concurrent.api.internal.OffloaderAwareExecutor

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, Executor, SignalOffloaderFactory

public final class OffloaderAwareExecutor
extends java.lang.Object
implements Executor, SignalOffloaderFactory

An Executor which is also a SignalOffloaderFactory and hence can influence a specific SignalOffloader used by this Executor.

Constructor Summary

Constructors

Constructor and Description
OffloaderAwareExecutor(Executor delegate, SignalOffloaderFactory offloaderFactory) New instance.

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync() Used to close/shutdown a resource.
static Executor	ensureThreadAffinity(Executor executor) If the passed Executor does not honor thread affinity then return a new Executor that does honor thread affinity.
Cancellable	execute(java.lang.Runnable task) Executes the passed task as soon as possible.
boolean	hasThreadAffinity() Returns true if and only if all SignalOffloader instances will always provide thread affinity.
SignalOffloader	newSignalOffloader(Executor executor) Creates a new SignalOffloader.
Completable	onClose() Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Cancellable	schedule(java.lang.Runnable task, long delay, java.util.concurrent.TimeUnit unit) Executes the passed task after delay amount of units time has passed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.servicetalk.concurrent.api.Executor

submit, submit, submitCallable, submitRunnable, timer, timer

Methods inherited from interface io.servicetalk.concurrent.Executor

schedule

Methods inherited from interface io.servicetalk.concurrent.api.AsyncCloseable

closeAsyncGracefully

Constructor Detail

OffloaderAwareExecutor

public OffloaderAwareExecutor(Executor delegate,
                              SignalOffloaderFactory offloaderFactory)

New instance.

Parameters:

delegate - Actual Executor to use.

offloaderFactory - SignalOffloaderFactory to use.

Method Detail

execute

public Cancellable execute(java.lang.Runnable task)
                    throws java.util.concurrent.RejectedExecutionException

Description copied from interface: Executor

Executes the passed task as soon as possible.

Specified by:

execute in interface Executor

Parameters:

task - to execute.

Returns:

Cancellable to cancel the task if not yet executed.

Throws:

java.util.concurrent.RejectedExecutionException - If the task is rejected.

schedule

public Cancellable schedule(java.lang.Runnable task,
                            long delay,
                            java.util.concurrent.TimeUnit unit)
                     throws java.util.concurrent.RejectedExecutionException

Description copied from interface: Executor

Executes the passed task after delay amount of units time has passed.

Note this method is not guaranteed to provide real time execution. For example implementations are free to consolidate tasks into time buckets to reduce the overhead of timer management at the cost of reduced timer fidelity.

Specified by:

schedule in interface Executor

Parameters:

task - to execute.

delay - The time duration that is allowed to elapse before task is executed.

unit - The units for delay.

Returns:

Cancellable to cancel the task if not yet executed.

Throws:

java.util.concurrent.RejectedExecutionException - If the task is rejected.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A CompletableSource that is notified once the close is complete.

newSignalOffloader

public SignalOffloader newSignalOffloader(Executor executor)

Description copied from interface: SignalOffloaderFactory

Creates a new SignalOffloader.

Specified by:

newSignalOffloader in interface SignalOffloaderFactory

Parameters:

executor - Executor to be used by the returned SignalOffloader.

Returns:

A new SignalOffloader.

hasThreadAffinity

public boolean hasThreadAffinity()

Description copied from interface: SignalOffloaderFactory

Returns true if and only if all SignalOffloader instances will always provide thread affinity. A SignalOffloader providing thread affinity will offload all signals using a single thread.

Specified by:

hasThreadAffinity in interface SignalOffloaderFactory

Returns:

true if and only if all SignalOffloader instances will always provide thread affinity.

ensureThreadAffinity

public static Executor ensureThreadAffinity(Executor executor)

If the passed Executor does not honor thread affinity then return a new Executor that does honor thread affinity.

Parameters:

executor - Executor to inspect and wrap if required.

Returns:

An Executor that honors thread affinity.