Package com.velocitypowered.api.event

Interface EventTask

public interface EventTask

Represents a task that can be returned by a EventHandler which allows event handling to be suspended and resumed at a later time, and executing event handlers completely or partially asynchronously.

By default will all event handlers be executed on the thread the event was posted, this behavior can be altered by using event tasks.

Method Summary

Modifier and Type	Method	Description
static EventTask	async(Runnable task)	Creates a basic async EventTask from the given Runnable.
void	execute(Continuation continuation)	Runs this event task with the given Continuation.
boolean	requiresAsync()	Whether this EventTask is required to be called asynchronously.
static EventTask	resumeWhenComplete(CompletableFuture<?> future)	Creates an continuation based EventTask for the given CompletableFuture.
static EventTask	withContinuation(Consumer<Continuation> task)	Creates an continuation based EventTask from the given Consumer.

Method Detail

requiresAsync

boolean requiresAsync()

Whether this EventTask is required to be called asynchronously.

If this method returns true, the event task is guaranteed to be executed asynchronously from the current thread. Otherwise, the event task may be executed on the current thread or asynchronously.

Returns:

Requires async

execute

void execute(Continuation continuation)

Runs this event task with the given Continuation. The continuation must be notified when the task is completed, either with Continuation.resume() if the task was successful or Continuation.resumeWithException(Throwable) if an exception occurred.

The Continuation may only be resumed once, or an IllegalStateException will be thrown.

The Continuation doesn't need to be notified during the execution of this method, this can happen at a later point in time and from another thread.

Parameters:

continuation - The continuation

async

static EventTask async(Runnable task)

Creates a basic async EventTask from the given Runnable. The task is guaranteed to be executed asynchronously (requiresAsync() always returns true).

Parameters:

task - The task

Returns:

The async event task

withContinuation

static EventTask withContinuation(Consumer<Continuation> task)

Creates an continuation based EventTask from the given Consumer. The task isn't guaranteed to be executed asynchronously (requiresAsync() always returns false).

Parameters:

task - The task to execute

Returns:

The event task

resumeWhenComplete

static EventTask resumeWhenComplete(CompletableFuture<?> future)

Creates an continuation based EventTask for the given CompletableFuture. The continuation will be notified once the given future is completed.

Parameters:

future - The task to wait for

Returns:

The event task