Package net.officefloor.frame.internal.structure

Interface AssetLatch

All Known Implementing Classes:

AssetLatchImpl

public interface AssetLatch

Latch on an Asset to only allow the ThreadState instances proceed when Asset is ready.

May be used as a LinkedListSetEntry in a list of AssetLatch instances for an AssetManager.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
FunctionState	awaitOnAsset(FunctionState function)	Flags for the FunctionState (and more specifically the ThreadState of the FunctionState) to wait until the Asset is ready.
void	failFunctions(java.lang.Throwable failure, boolean isPermanent)	Fails the FunctionState instances waiting on this Asset.
Asset	getAsset()	Obtains the Asset for this AssetLatch.
void	releaseFunctions(boolean isPermanent)	Releases the FunctionState instances waiting on the Asset.
void	releaseFunctions(boolean isPermanent, FunctionState functionState)	Releases the FunctionState instances waiting on the Asset.

Method Detail

getAsset

Asset getAsset()

Obtains the Asset for this AssetLatch.

Returns:

Asset for this AssetLatch.

awaitOnAsset

FunctionState awaitOnAsset(FunctionState function)

Flags for the FunctionState (and more specifically the ThreadState of the FunctionState) to wait until the Asset is ready.

This is typically because the Asset is doing some processing that the FunctionState requires completed before proceeding.

Parameters:

function - FunctionState to be released when the Asset is ready.

Returns:

Optional FunctionState to execute to wait on the Asset.

releaseFunctions

void releaseFunctions(boolean isPermanent)

Releases the FunctionState instances waiting on the Asset.

Parameters:

isPermanent - true indicates that all FunctionState instances added to the AssetLatch from now on are activated immediately. It is useful to flag an AssetLatch in this state when the Asset is no longer being used to stop a FunctionState from waiting forever.

releaseFunctions

void releaseFunctions(boolean isPermanent,
                      FunctionState functionState)

Releases the FunctionState instances waiting on the Asset.

Parameters:

isPermanent - true indicates that all FunctionState instances added to the AssetLatch from now on are activated immediately. It is useful to flag an AssetLatch in this state when the Asset is no longer being used to stop a FunctionState from waiting forever.

functionState - FunctionState to be executed first before each currently waiting FunctionState.

failFunctions

void failFunctions(java.lang.Throwable failure,
                   boolean isPermanent)

Fails the FunctionState instances waiting on this Asset.

Parameters:

failure - Failure to propagate to the ThreadState of the FunctionState instances waiting on the Asset.

isPermanent - true indicates that all FunctionState instances added to the AssetLatch from now on are activated immediately with the input failure. It is useful to flag an AssetLatch in this state when the Asset is in a failed state that can not be recovered from.