Package sonia.scm.repository.spi

Interface SyncAsyncExecutor

public interface SyncAsyncExecutor

Tasks submitted to this executor will be run synchronously up to a given time, after which they will be queued and processed asynchronously. After a maximum amount of time consumed by these tasks, they will be skipped. Note that this only works for short-living tasks.

Get instances of this using a SyncAsyncExecutorProvider.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	SyncAsyncExecutor.ExecutionType

Method Summary

Modifier and Type	Method	Description
default SyncAsyncExecutor.ExecutionType	execute(Runnable task)	Execute the given task (either synchronously or asynchronously).
default SyncAsyncExecutor.ExecutionType	execute(Runnable task, Runnable abortionFallback)	Execute the given task (either synchronously or asynchronously).
default SyncAsyncExecutor.ExecutionType	execute(Consumer<SyncAsyncExecutor.ExecutionType> task)	Execute the given task (either synchronously or asynchronously).
SyncAsyncExecutor.ExecutionType	execute(Consumer<SyncAsyncExecutor.ExecutionType> task, Runnable abortionFallback)	Execute the given task (either synchronously or asynchronously).
boolean	hasExecutedAllSynchronously()	When all submitted tasks have been executed synchronously, this will return true.

Method Details

execute

default SyncAsyncExecutor.ExecutionType execute(Runnable task)

Execute the given task (either synchronously or asynchronously). If this task is skipped due to timeouts, nothing will be done.

Parameters:

task - The Runnable to be executed.

Returns:

Either SyncAsyncExecutor.ExecutionType.SYNCHRONOUS when the given Runnable has been executed immediately or SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS, when the task was queued to be executed asynchronously in the future.

execute

default SyncAsyncExecutor.ExecutionType execute(Runnable task,
 Runnable abortionFallback)

Execute the given task (either synchronously or asynchronously). If this task is skipped due to timeouts, the abortionFallback will be called.

Parameters:

task - The Runnable to be executed.

abortionFallback - This will only be run, when this and all remaining tasks are aborted. This task should only consume a negligible amount of time.

Returns:

Either SyncAsyncExecutor.ExecutionType.SYNCHRONOUS when the given Runnable has been executed immediately or SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS, when the task was queued to be executed asynchronously in the future.

execute

default SyncAsyncExecutor.ExecutionType execute(Consumer<SyncAsyncExecutor.ExecutionType> task)

Execute the given task (either synchronously or asynchronously). If this task is skipped due to timeouts, nothing will be done.

Parameters:

task - The Consumer to be executed. The parameter given to this is either SyncAsyncExecutor.ExecutionType.SYNCHRONOUS when the given Consumer is executed immediately or SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS, when the task had been queued and now is executed asynchronously.

Returns:

Either SyncAsyncExecutor.ExecutionType.SYNCHRONOUS when the given Runnable has been executed immediately or SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS, when the task was queued to be executed asynchronously in the future.

execute

SyncAsyncExecutor.ExecutionType execute(Consumer<SyncAsyncExecutor.ExecutionType> task,
 Runnable abortionFallback)

Execute the given task (either synchronously or asynchronously). If this task is skipped due to timeouts, the abortionFallback will be called.

Parameters:

task - The Consumer to be executed. The parameter given to this is either SyncAsyncExecutor.ExecutionType.SYNCHRONOUS when the given Consumer is executed immediately or SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS, when the task had been queued and now is executed asynchronously.

abortionFallback - This will only be run, when this and all remaining tasks are aborted. This task should only consume a negligible amount of time.

Returns:

Either SyncAsyncExecutor.ExecutionType.SYNCHRONOUS when the given Runnable has been executed immediately or SyncAsyncExecutor.ExecutionType.ASYNCHRONOUS, when the task was queued to be executed asynchronously in the future.

hasExecutedAllSynchronously

boolean hasExecutedAllSynchronously()

When all submitted tasks have been executed synchronously, this will return true. If at least one task has been enqueued to be executed asynchronously, this returns false (even when none of the enqueued tasks have been run, yet).