Module qilletni.api

Package dev.qilletni.api.lang.internal

Interface BackgroundTaskExecutor

public interface BackgroundTaskExecutor

Allows for background processes to be run, or effectively async callbacks. This is done by passing this interface a Runnable, which runs a condition ID. With that, the condition ID can be activated, meaning the next break in expression invocation will run the runnable.
Qilletni strictly doesn't support multithreading, but native Java functions can for processing. Any async thread should NOT use any Qilletni APIs, aside from this class or any others that are deemed safe.

Method Summary

Modifier and Type	Method	Description
void	blockAndRunBackgroundTasks()	Blocks the current thread and runs background tasks immediately when they become available.
void	checkAndRunBackgroundTasks()	Checks if any conditions are triggered and runs them if they are.
int	runWhenCondition(Runnable callback)	A condition that is run in between expression invocation breaks when the condition ID is triggered.
<T> int	runWhenCondition(Consumer<T> callback)	A condition that is run in between expression invocation breaks when the condition ID is triggered.
void	triggerCondition(int conditionId)	Activates a condition from its ID.
void	triggerCondition(int conditionId, Object param)	Activates a condition from its ID.

Method Details

runWhenCondition

int runWhenCondition(Runnable callback)

A condition that is run in between expression invocation breaks when the condition ID is triggered.

Parameters:

callback - The callback to invoke

Returns:

A number representing a condition ID

runWhenCondition

<T> int runWhenCondition(Consumer<T> callback)

A condition that is run in between expression invocation breaks when the condition ID is triggered.

Parameters:

callback - The callback to invoke with a given parameter. If triggerCondition(int) is used for this condition instead of triggerCondition(int, Object), the trigger is ignored.

Returns:

A number representing a condition ID

triggerCondition

void triggerCondition(int conditionId)

Activates a condition from its ID.

Parameters:

conditionId - The condition ID to activate

triggerCondition

void triggerCondition(int conditionId,
 Object param)

Activates a condition from its ID.

Parameters:

conditionId - The condition ID to activate

param - The parameter given to the callback consumer

checkAndRunBackgroundTasks

void checkAndRunBackgroundTasks()

Checks if any conditions are triggered and runs them if they are. This is mainly used for internal purposes, and should ONLY be run in the main thread.

blockAndRunBackgroundTasks

void blockAndRunBackgroundTasks()

Blocks the current thread and runs background tasks immediately when they become available.