Package io.deephaven.engine.updategraph

Class UpdateGraphLock

java.lang.Object

io.deephaven.engine.updategraph.UpdateGraphLock

public abstract class UpdateGraphLock
extends Object

Lock class to support UpdateGraph.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateGraphLock.Instrumentation	Instrumentation interface for recording lock events.

Field Summary

Fields

Modifier and Type	Field	Description
protected final UpdateGraph	updateGraph	The UpdateGraph used for instrumentation and assertions.

Method Summary

Modifier and Type	Method	Description
static UpdateGraphLock	create(@NotNull UpdateGraph updateGraph, boolean allowUnitTestMode)	Construct a lock for a new UpdateGraph instance.
abstract AwareFunctionalLock	exclusiveLock()	Get the exclusive lock (similar to ReadWriteLock.writeLock() ()}, but with UGP-specific instrumentation).
static void	installInstrumentation(@Nullable UpdateGraphLock.Instrumentation instrumentation)	Install an instrumentation recorder for all UpdateGraphLock instances.
abstract void	reset()	Reset this UpdateGraphLock between unit tests to ensure a clean slate.
abstract AwareFunctionalLock	sharedLock()	Get the shared lock (similar to ReadWriteLock.readLock(), but with UGP-specific instrumentation).

Methods inherited from class java.lang.Object

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

Field Details

updateGraph

protected final UpdateGraph updateGraph

The UpdateGraph used for instrumentation and assertions.

Method Details

installInstrumentation

public static void installInstrumentation(@Nullable
 @Nullable UpdateGraphLock.Instrumentation instrumentation)

Install an instrumentation recorder for all UpdateGraphLock instances.

Parameters:

instrumentation - The instrumentation recorder, or null to install a no-op recorder.

create

public static UpdateGraphLock create(@NotNull
 @NotNull UpdateGraph updateGraph,
 boolean allowUnitTestMode)

Construct a lock for a new UpdateGraph instance.

Parameters:

updateGraph - The UpdateGraph instance to use

allowUnitTestMode - Whether this lock instance is to be used for unit tests only

sharedLock

public abstract AwareFunctionalLock sharedLock()

Get the shared lock (similar to ReadWriteLock.readLock(), but with UGP-specific instrumentation). See UpdateGraph.sharedLock() for user-facing documentation.

Returns:

The shared lock

exclusiveLock

public abstract AwareFunctionalLock exclusiveLock()

Get the exclusive lock (similar to ReadWriteLock.writeLock() ()}, but with UGP-specific instrumentation). See UpdateGraph.exclusiveLock() for user-facing documentation.

Returns:

The exclusive lock

reset

@TestUseOnly
public abstract void reset()

Reset this UpdateGraphLock between unit tests to ensure a clean slate.