Package io.deephaven.engine.context

Class PoisonedUpdateGraph

java.lang.Object

io.deephaven.engine.context.PoisonedUpdateGraph

All Implemented Interfaces:

LogOutputAppendable, NotificationQueue, NotificationQueue.Dependency, UpdateGraph, UpdateSourceRegistrar

public class PoisonedUpdateGraph
extends Object
implements UpdateGraph

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.engine.updategraph.NotificationQueue

NotificationQueue.Dependency, NotificationQueue.ErrorNotification, NotificationQueue.Notification

Field Summary

Fields

Modifier and Type	Field	Description
static final PoisonedUpdateGraph	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	addNotification(@NotNull NotificationQueue.Notification notification)	Add a notification for this NotificationQueue to deliver (by invoking its run() method).
void	addNotifications(@NotNull Collection<? extends NotificationQueue.Notification> notifications)	Enqueue a collection of notifications to be flushed.
void	addSource(@NotNull Runnable updateSource)	Add a source to this registrar.
LogOutput	append(LogOutput logOutput)
LogicalClock	clock()
boolean	currentThreadProcessesUpdates()	Test if the current thread is involved in processing updates for this UpdateGraph.
AwareFunctionalLock	exclusiveLock()
String	getName()
UpdateGraph	getUpdateGraph()
LogEntry	logDependencies()
boolean	maybeAddNotification(@NotNull NotificationQueue.Notification notification, long deliveryStep)	Add a notification for this NotificationQueue to deliver (by invoking its run() method), iff the delivery step is the current step and the update cycle for that step is still in process.
int	parallelismFactor()	Retrieve the number of independent update propagation tasks this UpdateGraph can process concurrently.
void	removeSource(@NotNull Runnable updateSource)	Remove a source from this registrar.
void	requestRefresh()	Request that this UpdateGraph process any pending updates as soon as practicable.
boolean	satisfied(long step)	Is this ancestor satisfied? Note that this method must be safe to call on any thread.
boolean	serialTableOperationsSafe()	Test if engine code executing on the current thread should assume safety for serial table operations.
boolean	setSerialTableOperationsSafe(boolean newValue)	User or engine code that makes its own determination about the safety of initiating serial table operations on the current thread may use this method to override default behavior.
AwareFunctionalLock	sharedLock()
void	stop()	Attempt to stop this update graph, and cease processing further notifications.
boolean	supportsRefreshing()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.updategraph.NotificationQueue.Dependency

getUpdateGraph

Methods inherited from interface io.deephaven.engine.updategraph.UpdateGraph

allowSerialTableOperations, allowSerialTableOperations, cast, checkInitiateSerialTableOperation, requestSignal, runWhenIdle

Methods inherited from interface io.deephaven.engine.updategraph.UpdateSourceRegistrar

removeSources

Field Details

INSTANCE

public static final PoisonedUpdateGraph INSTANCE

Method Details

append

public LogOutput append(LogOutput logOutput)

Specified by:

append in interface LogOutputAppendable

satisfied

public boolean satisfied(long step)

Description copied from interface: NotificationQueue.Dependency

Is this ancestor satisfied? Note that this method must be safe to call on any thread.

Specified by:

satisfied in interface NotificationQueue.Dependency

Parameters:

step - The step for which we are testing satisfaction

Returns:

Whether the dependency is satisfied on step (and will not fire subsequent notifications)

getUpdateGraph

public UpdateGraph getUpdateGraph()

Specified by:

getUpdateGraph in interface NotificationQueue.Dependency

Returns:

the update graph that this dependency is a part of

getName

public String getName()

Specified by:

getName in interface UpdateGraph

Returns:

The name of this UpdateGraph

addNotification

public void addNotification(@NotNull
 @NotNull NotificationQueue.Notification notification)

Description copied from interface: NotificationQueue

Add a notification for this NotificationQueue to deliver (by invoking its run() method). Note that implementations may have restrictions as to how and when this method may be used for non-terminal notifications, e.g. by only supporting notification queuing from threads that can guarantee they are part of an update cycle.

Specified by:

addNotification in interface NotificationQueue

Parameters:

notification - The notification to add

addNotifications

public void addNotifications(@NotNull
 @NotNull Collection<? extends NotificationQueue.Notification> notifications)

Description copied from interface: NotificationQueue

Enqueue a collection of notifications to be flushed.

Specified by:

addNotifications in interface NotificationQueue

Parameters:

notifications - The notification to enqueue

See Also:

• NotificationQueue.addNotification(Notification)

maybeAddNotification

public boolean maybeAddNotification(@NotNull
 @NotNull NotificationQueue.Notification notification,
 long deliveryStep)

Description copied from interface: NotificationQueue

Add a notification for this NotificationQueue to deliver (by invoking its run() method), iff the delivery step is the current step and the update cycle for that step is still in process. This is only supported for non-terminal notifications.

Specified by:

maybeAddNotification in interface NotificationQueue

Parameters:

notification - The notification to add

deliveryStep - The step to deliver this notification on

sharedLock

public AwareFunctionalLock sharedLock()

Specified by:

sharedLock in interface UpdateGraph

Returns:

The shared AwareFunctionalLock to use with this update graph

exclusiveLock

public AwareFunctionalLock exclusiveLock()

Specified by:

exclusiveLock in interface UpdateGraph

Returns:

The exclusive AwareFunctionalLock to use with this update graph

clock

public LogicalClock clock()

Specified by:

clock in interface UpdateGraph

Returns:

The LogicalClock to use with this update graph

parallelismFactor

public int parallelismFactor()

Description copied from interface: UpdateGraph

Retrieve the number of independent update propagation tasks this UpdateGraph can process concurrently.

For example, an implementation using a fixed-size thread pool of update task workers should return the size of the thread pool.

This is exposed in order to allow users to determine the ideal way to partition their queries for maximum parallelism without undue overhead.

Specified by:

parallelismFactor in interface UpdateGraph

Returns:

number of independent update propagation tasks this UpdateGraph can process concurrently

logDependencies

public LogEntry logDependencies()

Specified by:

logDependencies in interface UpdateGraph

Returns:

A LogEntry that may be prefixed with UpdateGraph information

currentThreadProcessesUpdates

public boolean currentThreadProcessesUpdates()

Description copied from interface: UpdateGraph

Test if the current thread is involved in processing updates for this UpdateGraph. If so, non-terminal user notifications on the current thread must not attempt to lock this UpdateGraph.

Specified by:

currentThreadProcessesUpdates in interface UpdateGraph

Returns:

Whether the current thread is involved in processing updates for this UpdateGraph

serialTableOperationsSafe

public boolean serialTableOperationsSafe()

Description copied from interface: UpdateGraph

Test if engine code executing on the current thread should assume safety for serial table operations. Operations annotated as concurrent are always safe.

Specified by:

serialTableOperationsSafe in interface UpdateGraph

Returns:

Whether code on this thread should assume serial table operation safety

See Also:

• UpdateGraph.checkInitiateSerialTableOperation()
• UpdateGraph.setSerialTableOperationsSafe(boolean)
• UpdateGraph.allowSerialTableOperations(Supplier)
• UpdateGraph.allowSerialTableOperations(ThrowingSupplier)

setSerialTableOperationsSafe

public boolean setSerialTableOperationsSafe(boolean newValue)

Description copied from interface: UpdateGraph

User or engine code that makes its own determination about the safety of initiating serial table operations on the current thread may use this method to override default behavior. The previous value should be restored immediately after use, typically with the following pattern:

 boolean oldValue = assumeSerialTableOperations(true);
 try {
     // ... safe table operations here
 } finally {
     assumeSerialTableOperations(oldValue);
 }
 

Specified by:

setSerialTableOperationsSafe in interface UpdateGraph

Parameters:

newValue - the new value

Returns:

the old value

See Also:

• UpdateGraph.serialTableOperationsSafe()
• UpdateGraph.allowSerialTableOperations(Supplier)
• UpdateGraph.allowSerialTableOperations(ThrowingSupplier)

addSource

public void addSource(@NotNull
 @NotNull Runnable updateSource)

Description copied from interface: UpdateSourceRegistrar

Add a source to this registrar.

Specified by:

addSource in interface UpdateSourceRegistrar

Parameters:

updateSource - The table to add

removeSource

public void removeSource(@NotNull
 @NotNull Runnable updateSource)

Description copied from interface: UpdateSourceRegistrar

Remove a source from this registrar.

Specified by:

removeSource in interface UpdateSourceRegistrar

Parameters:

updateSource - The table to remove

supportsRefreshing

public boolean supportsRefreshing()

Specified by:

supportsRefreshing in interface UpdateGraph

Returns:

Whether this UpdateGraph has a mechanism that supports refreshing

requestRefresh

public void requestRefresh()

Description copied from interface: UpdateGraph

Request that this UpdateGraph process any pending updates as soon as practicable. Updates "hurried" in this way are otherwise processed as normal.

Specified by:

requestRefresh in interface UpdateGraph

Specified by:

requestRefresh in interface UpdateSourceRegistrar

stop

public void stop()

Description copied from interface: UpdateGraph

Attempt to stop this update graph, and cease processing further notifications.

Specified by:

stop in interface UpdateGraph