com.cjcrafter.foliascheduler

Interface AsyncSchedulerImplementation

public interface AsyncSchedulerImplementation

Represents a scheduler that can schedule tasks to be run asynchronously (separate from the server thread(s)).

Method Summary

Modifier and Type	Method and Description
void	cancelTasks() Cancels all async tasks that were scheduled using your Plugin instance.
default @NotNull TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay, long ticks) Schedules a task to be run asynchronously after a delay and then repeatedly after a period, in ticks.
default @NotNull TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay, long period, @NotNull java.util.concurrent.TimeUnit unit) Schedules a task to be run asynchronously after a delay and then repeatedly after a period.
default <T> @NotNull TaskImplementation<T>	runAtFixedRate(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay, long ticks) Schedules a task to be run asynchronously after a delay and then repeatedly after a period, in ticks.
<T> @NotNull TaskImplementation<T>	runAtFixedRate(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay, long period, @NotNull java.util.concurrent.TimeUnit unit) Schedules a task to be run asynchronously after a delay and then repeatedly after a period.
default @NotNull TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.lang.Runnable runnable, long delay, long ticks) Schedules a task to be run asynchronously after a delay and then repeatedly after a period, in ticks.
default @NotNull TaskImplementation<java.lang.Void>	runAtFixedRate(@NotNull java.lang.Runnable runnable, long delay, long period, @NotNull java.util.concurrent.TimeUnit unit) Schedules a task to be run asynchronously after a delay and then repeatedly after a period.
default @NotNull TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long ticks) Schedules a task to be run asynchronously after a delay, in ticks.
default @NotNull TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer, long delay, @NotNull java.util.concurrent.TimeUnit unit) Schedules a task to be run asynchronously after a delay.
default <T> @NotNull TaskImplementation<T>	runDelayed(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long ticks) Schedules a task to be run asynchronously after a delay, in ticks.
<T> @NotNull TaskImplementation<T>	runDelayed(@NotNull java.util.function.Function<TaskImplementation<T>,T> function, long delay, @NotNull java.util.concurrent.TimeUnit unit) Schedules a task to be run asynchronously after a delay.
default @NotNull TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.lang.Runnable runnable, long ticks) Schedules a task to be run asynchronously after a delay, in ticks.
default @NotNull TaskImplementation<java.lang.Void>	runDelayed(@NotNull java.lang.Runnable runnable, long delay, @NotNull java.util.concurrent.TimeUnit unit) Schedules a task to be run asynchronously after a delay.
default @NotNull TaskImplementation<java.lang.Void>	runNow(@NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer) Runs a task asynchronously immediately.
<T> @NotNull TaskImplementation<T>	runNow(@NotNull java.util.function.Function<TaskImplementation<T>,T> function) Runs a task asynchronously immediately.
default @NotNull TaskImplementation<java.lang.Void>	runNow(@NotNull java.lang.Runnable runnable) Runs a task asynchronously immediately.

Method Detail

runNow

@NotNull
<T> @NotNull TaskImplementation<T> runNow(@NotNull
                                                   @NotNull java.util.function.Function<TaskImplementation<T>,T> function)

Runs a task asynchronously immediately.

runNow

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runNow(@NotNull
                                                                    @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer)

Runs a task asynchronously immediately.

runNow

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runNow(@NotNull
                                                                    @NotNull java.lang.Runnable runnable)

Runs a task asynchronously immediately.

runDelayed

@NotNull
<T> @NotNull TaskImplementation<T> runDelayed(@NotNull
                                                       @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                       long delay,
                                                       @NotNull
                                                       @NotNull java.util.concurrent.TimeUnit unit)

Schedules a task to be run asynchronously after a delay.

Parameters:

function - The task to run.

delay - The delay before the task is run.

unit - The time unit of the delay.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                        @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                        long delay,
                                                                        @NotNull
                                                                        @NotNull java.util.concurrent.TimeUnit unit)

Schedules a task to be run asynchronously after a delay.

Parameters:

consumer - The task to run.

delay - The delay before the task is run.

unit - The time unit of the delay.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                        @NotNull java.lang.Runnable runnable,
                                                                        long delay,
                                                                        @NotNull
                                                                        @NotNull java.util.concurrent.TimeUnit unit)

Schedules a task to be run asynchronously after a delay.

Parameters:

runnable - The task to run.

delay - The delay before the task is run.

unit - The time unit of the delay.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default <T> @NotNull TaskImplementation<T> runDelayed(@NotNull
                                                               @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                               long ticks)

Schedules a task to be run asynchronously after a delay, in ticks.

Parameters:

function - The task to run.

ticks - The delay in ticks before the task is run.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                        @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                        long ticks)

Schedules a task to be run asynchronously after a delay, in ticks.

Parameters:

consumer - The task to run.

ticks - The delay in ticks before the task is run.

Returns:

The task that was scheduled.

runDelayed

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runDelayed(@NotNull
                                                                        @NotNull java.lang.Runnable runnable,
                                                                        long ticks)

Schedules a task to be run asynchronously after a delay, in ticks.

Parameters:

runnable - The task to run.

ticks - The delay in ticks before the task is run.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
<T> @NotNull TaskImplementation<T> runAtFixedRate(@NotNull
                                                           @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                           long delay,
                                                           long period,
                                                           @NotNull
                                                           @NotNull java.util.concurrent.TimeUnit unit)

Schedules a task to be run asynchronously after a delay and then repeatedly after a period.

Parameters:

function - The task to run.

delay - The delay before the task is run.

period - The period between each run.

unit - The time unit of the delay and period.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                            @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                            long delay,
                                                                            long period,
                                                                            @NotNull
                                                                            @NotNull java.util.concurrent.TimeUnit unit)

Schedules a task to be run asynchronously after a delay and then repeatedly after a period.

Parameters:

consumer - The task to run.

delay - The delay before the task is run.

period - The period between each run.

unit - The time unit of the delay and period.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                            @NotNull java.lang.Runnable runnable,
                                                                            long delay,
                                                                            long period,
                                                                            @NotNull
                                                                            @NotNull java.util.concurrent.TimeUnit unit)

Schedules a task to be run asynchronously after a delay and then repeatedly after a period.

Parameters:

runnable - The task to run.

delay - The delay before the task is run.

period - The period between each run.

unit - The time unit of the delay and period.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
default <T> @NotNull TaskImplementation<T> runAtFixedRate(@NotNull
                                                                   @NotNull java.util.function.Function<TaskImplementation<T>,T> function,
                                                                   long delay,
                                                                   long ticks)

Schedules a task to be run asynchronously after a delay and then repeatedly after a period, in ticks.

Parameters:

function - The task to run.

delay - The delay in ticks before the task is run.

ticks - The period in ticks between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                            @NotNull java.util.function.Consumer<TaskImplementation<java.lang.Void>> consumer,
                                                                            long delay,
                                                                            long ticks)

Schedules a task to be run asynchronously after a delay and then repeatedly after a period, in ticks.

Parameters:

consumer - The task to run.

delay - The delay in ticks before the task is run.

ticks - The period in ticks between each run.

Returns:

The task that was scheduled.

runAtFixedRate

@NotNull
default @NotNull TaskImplementation<java.lang.Void> runAtFixedRate(@NotNull
                                                                            @NotNull java.lang.Runnable runnable,
                                                                            long delay,
                                                                            long ticks)

Schedules a task to be run asynchronously after a delay and then repeatedly after a period, in ticks.

Parameters:

runnable - The task to run.

delay - The delay in ticks before the task is run.

ticks - The period in ticks between each run.

Returns:

The task that was scheduled.

cancelTasks

void cancelTasks()

Cancels all async tasks that were scheduled using your Plugin instance.

Note that the behavior of this method changes depending on the server implementation. For example, in Spigot, this method will cancel all tasks (sync + async) scheduled by the plugin, while in Paper/Folia, this method will only cancel tasks scheduled using the async scheduler.

See Also:

GlobalSchedulerImplementation.cancelTasks(), Issue #28