Package io.deephaven.engine.updategraph

Class UpdateSourceCombiner

java.lang.Object

io.deephaven.util.referencecounting.ReferenceCounted

io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

io.deephaven.engine.liveness.ReferenceCountedLivenessNode

io.deephaven.engine.liveness.LivenessArtifact

io.deephaven.engine.updategraph.UpdateSourceCombiner

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, NotificationQueue.Dependency, UpdateSourceRegistrar, Serializable, Runnable

public class UpdateSourceCombiner
extends LivenessArtifact
implements Runnable, UpdateSourceRegistrar

Update source that combines multiple sources in order to force them to be refreshed as a unit within the update graph provided at construction.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
UpdateSourceCombiner(@NotNull UpdateGraph updateGraph)	Construct an UpdateSourceCombiner with default parameters.
UpdateSourceCombiner(@NotNull UpdateGraph updateGraph, boolean parallel, @NotNull Supplier<WeakReferenceManager<Runnable>> weakReferenceManagerFactory)	Construct an UpdateSourceCombiner.

Method Summary

Modifier and Type	Method	Description
void	addSource(@NotNull Runnable updateSource)	Add a source to this registrar.
void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
UpdateGraph	getUpdateGraph()
void	install()	Add this UpdateSourceCombiner to the update graph passed at construction.
void	removeSource(@NotNull Runnable updateSource)	Remove a source from this registrar.
void	requestRefresh()	Passes through to the update graph passed at construction.
void	run()
boolean	satisfied(long step)	Is this ancestor satisfied? Note that this method must be safe to call on any thread.

Methods inherited from class io.deephaven.engine.liveness.LivenessArtifact

manageWithCurrentScope

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessNode

getWeakReference, initializeTransientFieldsForLiveness, onReferenceCountAtZero, tryManage, tryUnmanage, tryUnmanage

Methods inherited from class io.deephaven.engine.liveness.ReferenceCountedLivenessReferent

dropReference, tryRetainReference

Methods inherited from class io.deephaven.util.referencecounting.ReferenceCounted

append, decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, toString, tryDecrementReferenceCount, tryIncrementReferenceCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.engine.liveness.LivenessManager

manage, unmanage, unmanage

Methods inherited from interface io.deephaven.engine.liveness.LivenessReferent

dropReference, getReferentDescription, retainReference, tryRetainReference

Methods inherited from interface io.deephaven.base.log.LogOutputAppendable

append

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

getUpdateGraph

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

removeSources

Constructor Details

UpdateSourceCombiner

public UpdateSourceCombiner(@NotNull
 @NotNull UpdateGraph updateGraph)

Construct an UpdateSourceCombiner with default parameters. The result will process updates serially, and will use a concurrent ArrayWeakReferenceManager.

Parameters:

updateGraph - The UpdateGraph to register with

UpdateSourceCombiner

public UpdateSourceCombiner(@NotNull
 @NotNull UpdateGraph updateGraph,
 boolean parallel,
 @NotNull
 @NotNull Supplier<WeakReferenceManager<Runnable>> weakReferenceManagerFactory)

Construct an UpdateSourceCombiner.

Parameters:

updateGraph - The UpdateGraph to register with

parallel - Whether to process updates in parallel

weakReferenceManagerFactory - Factory for the WeakReferenceManager to use when holding sources

Method Details

install

public void install()

Add this UpdateSourceCombiner to the update graph passed at construction. This should only be done once.

run

public void run()

Specified by:

run in interface Runnable

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

requestRefresh

public void requestRefresh()

Passes through to the update graph passed at construction.

Specified by:

requestRefresh in interface UpdateSourceRegistrar

destroy

@OverridingMethodsMustInvokeSuper
public void destroy()

Description copied from class: ReferenceCountedLivenessReferent

Attempt to release (destructively when necessary) resources held by this object. This may render the object unusable for subsequent operations. Implementations should be sure to call super.destroy().

This is intended to only ever be used as a side effect of decreasing the reference count to 0.

Overrides:

destroy in class ReferenceCountedLivenessReferent

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