Package net.officefloor.frame.impl.execute.asset

Class AssetLatchImpl

java.lang.Object

net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry<AssetLatchImpl,AssetManager>

net.officefloor.frame.impl.execute.asset.AssetLatchImpl

All Implemented Interfaces:

AssetLatch, CheckAssetContext, LinkedListSetEntry<AssetLatchImpl,AssetManager>

public class AssetLatchImpl
extends AbstractLinkedListSetEntry<AssetLatchImpl,AssetManager>
implements AssetLatch, CheckAssetContext

Implementation of the AssetLatch.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
AssetLatchImpl(Asset asset, AssetManagerImpl assetManager, MonitorClock clock)	Initiate.

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.
AssetManager	getLinkedListSetOwner()	Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.
long	getTime()	Obtains the time that check is being made.
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.

Methods inherited from class net.officefloor.frame.impl.execute.linkedlistset.AbstractLinkedListSetEntry

getNext, getPrev, setNext, setPrev

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetLatchImpl

public AssetLatchImpl(Asset asset,
                      AssetManagerImpl assetManager,
                      MonitorClock clock)

Initiate.

Parameters:

asset - Asset to be managed.

assetManager - AssetManager for managing this.

clock - MonitorClock.

Method Detail

getLinkedListSetOwner

public AssetManager getLinkedListSetOwner()

Description copied from interface: LinkedListSetEntry

Obtains the owner of the LinkedListSet that this LinkedListSetEntry may be added.

LinkedListSetEntry instances may only be added to the LinkedListSet they were intended for and can not be shared between LinkedListSet instances. This constraint:

1. ensures the integrity of the FunctionState, Flow, ThreadState, ProcessState structure, and
2. improves uniqueness performance as LinkedListSetEntry.getNext() and LinkedListSetEntry.getPrev() both returning null indicates not added

Specified by:

getLinkedListSetOwner in interface LinkedListSetEntry<AssetLatchImpl,AssetManager>

Returns:

Owner of the LinkedListSet that may contain this LinkedListSetEntry.

getAsset

public Asset getAsset()

Description copied from interface: AssetLatch

Obtains the Asset for this AssetLatch.

Specified by:

getAsset in interface AssetLatch

Returns:

Asset for this AssetLatch.

awaitOnAsset

public FunctionState awaitOnAsset(FunctionState function)

Description copied from interface: AssetLatch

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.

Specified by:

awaitOnAsset in interface AssetLatch

Parameters:

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

Returns:

Optional FunctionState to execute to wait on the Asset.

getTime

public long getTime()

Description copied from interface: CheckAssetContext

Obtains the time that check is being made.

As many Asset instances may be checked at the same time (or nanoseconds from each other) this provides optimisation to obtain the current time in milliseconds (equivalent to System.currentTimeMillis() for purpose of checking Asset timeouts).

Specified by:

getTime in interface CheckAssetContext

Returns:

System.currentTimeMillis() equivalent for checking Asset timeouts.

releaseFunctions

public void releaseFunctions(boolean isPermanent)

Description copied from interface: AssetLatch

Releases the FunctionState instances waiting on the Asset.

Specified by:

releaseFunctions in interface AssetLatch

Specified by:

releaseFunctions in interface CheckAssetContext

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

public void releaseFunctions(boolean isPermanent,
                             FunctionState functionState)

Description copied from interface: AssetLatch

Releases the FunctionState instances waiting on the Asset.

Specified by:

releaseFunctions in interface AssetLatch

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

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

Description copied from interface: AssetLatch

Fails the FunctionState instances waiting on this Asset.

Specified by:

failFunctions in interface AssetLatch

Specified by:

failFunctions in interface CheckAssetContext

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.