co.aikar.taskchain

Class TaskChainFactory

java.lang.Object

co.aikar.taskchain.TaskChainFactory

public class TaskChainFactory
extends Object

Constructor Summary

Constructors

Constructor and Description
TaskChainFactory(GameInterface impl)

Method Summary

Modifier and Type	Method and Description
BiConsumer<Exception,TaskChainTasks.Task<?,?>>	getDefaultErrorHandler() Returns the default error handler that will be used by all chains created by this factory, if they do not suspply their own error handler.
Map<String,Queue<co.aikar.taskchain.SharedTaskChain>>	getSharedChains()
<T> TaskChain<T>	newChain() Creates a new chain.
<T> TaskChain<T>	newSharedChain(String name) Allows re-use of a Chain by giving it a name.
void	setDefaultErrorHandler(BiConsumer<Exception,TaskChainTasks.Task<?,?>> errorHandler) Sets the default error handler used for all chains created by this factory, if they do not supply their own error handler.
void	shutdown(int duration, TimeUnit units) Shuts down the TaskChain system, forcing all tasks to run on current threads and finish.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskChainFactory

public TaskChainFactory(GameInterface impl)

Method Detail

getSharedChains

public Map<String,Queue<co.aikar.taskchain.SharedTaskChain>> getSharedChains()

newChain

public <T> TaskChain<T> newChain()

Creates a new chain.

newSharedChain

public <T> TaskChain<T> newSharedChain(String name)

Allows re-use of a Chain by giving it a name. This lets you keep adding Tasks to an already executing chain. This allows you to assure a sequence of events to only execute one at a time, but may be registered and executed from multiple execution points or threads. Task Data is not shared between chains of the same name. The only thing that is shared is execution order, in that 2 sequences of events can not run at the same time. If 2 chains are created at same time under same name, the first chain will execute fully before the 2nd chain will start, no matter how long

Parameters:

name - Name of the shared chain. Case sensitive

getDefaultErrorHandler

public BiConsumer<Exception,TaskChainTasks.Task<?,?>> getDefaultErrorHandler()

Returns the default error handler that will be used by all chains created by this factory, if they do not suspply their own error handler.

Returns:

The current default error handler

setDefaultErrorHandler

public void setDefaultErrorHandler(BiConsumer<Exception,TaskChainTasks.Task<?,?>> errorHandler)

Sets the default error handler used for all chains created by this factory, if they do not supply their own error handler.

Parameters:

errorHandler - The error handler

shutdown

public void shutdown(int duration,
                     TimeUnit units)

Shuts down the TaskChain system, forcing all tasks to run on current threads and finish.

Parameters:

duration - How long in the supplied units to wait before giving up the shutdown.

units - The units for how long to wait before giving up the shutdown