com.couchbase.lite.internal

Class AndroidExecutionService

java.lang.Object

com.couchbase.lite.internal.AbstractExecutionService

com.couchbase.lite.internal.AndroidExecutionService

All Implemented Interfaces:

ExecutionService

public final class AndroidExecutionService
extends AbstractExecutionService

ExecutionService for Android.

Nested Class Summary

Nested classes/interfaces inherited from interface com.couchbase.lite.internal.ExecutionService

ExecutionService.Cancellable, ExecutionService.CloseableExecutor

Field Summary

Fields inherited from class com.couchbase.lite.internal.AbstractExecutionService

MIN_CAPACITY

Constructor Summary

Constructors

Constructor and Description
AndroidExecutionService()

Method Summary

Modifier and Type	Method and Description
void	cancelDelayedTask(ExecutionService.Cancellable cancellableTask) Best effort, delete the passed task (obtained from postDelayedOnExecutor, above) from the wait queue.
Executor	getMainExecutor() Get the main executor.
ExecutionService.Cancellable	postDelayedOnExecutor(long delayMs, Executor executor, Runnable task) This runs a task on Android's main thread for just long enough to enough to enqueue the passed task on the passed executor.

Methods inherited from class com.couchbase.lite.internal.AbstractExecutionService

getConcurrentExecutor, getSerialExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidExecutionService

public AndroidExecutionService()

Method Detail

getMainExecutor

@NonNull
public Executor getMainExecutor()

Description copied from interface: ExecutionService

Get the main executor. It is guaranteed to be a single thread. The thread on which most of the application runs. Suitable for any task that doesn't take a long time to complete.

Returns:

the main executor.

postDelayedOnExecutor

@NonNull
public ExecutionService.Cancellable postDelayedOnExecutor(long delayMs,
                                                                   @NonNull
                                                                   Executor executor,
                                                                   @NonNull
                                                                   Runnable task)

This runs a task on Android's main thread for just long enough to enough to enqueue the passed task on the passed executor. It occupies space in the main looper's message queue but takes no significant time processing, there. If the target executor refuses the task, it is just dropped on the floor.

Parameters:

delayMs - delay before posting the task. There may be additional queue delays in the executor.

executor - an executor on which to execute the task.

task - the task to be executed.

Returns:

a cancellable task

cancelDelayedTask

public void cancelDelayedTask(@NonNull
                              ExecutionService.Cancellable cancellableTask)

Best effort, delete the passed task (obtained from postDelayedOnExecutor, above) from the wait queue. If it is already in the Executor, well, there you go.

Parameters:

cancellableTask - returned by a previous call to postDelayedOnExecutor.