Package net.minecraftforge.fml

Class DeferredWorkQueue

java.lang.Object

net.minecraftforge.fml.DeferredWorkQueue

public class DeferredWorkQueue
extends Object

Utility for running code on the main launch thread at the next available opportunity. There is no guaranteed order that work from various mods will be run, but your own work will be run sequentially.

Use of this class after startup is not possible. At that point, IThreadListener should be used instead.

Exceptions from tasks will be handled gracefully, causing a mod loading error. Tasks that take egregiously long times to run will be logged.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DeferredWorkQueue.TaskInfo

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.apache.logging.log4j.Logger	LOGGER
private final ModLoadingStage	modLoadingStage
private final ConcurrentLinkedDeque<DeferredWorkQueue.TaskInfo>	tasks
private static Map<Class<? extends ParallelDispatchEvent>,DeferredWorkQueue>	workQueues

Constructor Summary

Constructors

Constructor	Description
DeferredWorkQueue(ModLoadingStage modLoadingStage, Class<? extends ParallelDispatchEvent> eventClass)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	enqueueWork(net.minecraftforge.forgespi.language.IModInfo modInfo, Runnable work)
<T> CompletableFuture<T>	enqueueWork(net.minecraftforge.forgespi.language.IModInfo modInfo, Supplier<T> work)
static Optional<DeferredWorkQueue>	lookup(Optional<Class<? extends ParallelDispatchEvent>> parallelClass)
private static void	makeRunnable(DeferredWorkQueue.TaskInfo ti, Executor executor)
static CompletableFuture<Void>	runLater(Runnable workToEnqueue)	Deprecated.
(package private) void	runTasks()

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

workQueues

private static Map<Class<? extends ParallelDispatchEvent>,DeferredWorkQueue> workQueues

modLoadingStage

private final ModLoadingStage modLoadingStage

tasks

private final ConcurrentLinkedDeque<DeferredWorkQueue.TaskInfo> tasks

Constructor Details

DeferredWorkQueue

public DeferredWorkQueue(ModLoadingStage modLoadingStage,
 Class<? extends ParallelDispatchEvent> eventClass)

Method Details

lookup

public static Optional<DeferredWorkQueue> lookup(Optional<Class<? extends ParallelDispatchEvent>> parallelClass)

runTasks

void runTasks()

makeRunnable

private static void makeRunnable(DeferredWorkQueue.TaskInfo ti,
 Executor executor)

enqueueWork

public CompletableFuture<Void> enqueueWork(net.minecraftforge.forgespi.language.IModInfo modInfo,
 Runnable work)

enqueueWork

public <T> CompletableFuture<T> enqueueWork(net.minecraftforge.forgespi.language.IModInfo modInfo,
 Supplier<T> work)

runLater

@Deprecated
public static CompletableFuture<Void> runLater(Runnable workToEnqueue)

Deprecated.

DEPRECATED FOR REMOVAL. Use ParallelDispatchEvent.enqueueWork(Runnable) or ParallelDispatchEvent.enqueueWork(Supplier)

Parameters:

workToEnqueue - Runnable to execute later

Returns:

a completable future