Package io.deephaven.engine.table.impl

Class InstrumentedTableUpdateListenerAdapter

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.table.impl.InstrumentedTableListenerBase

io.deephaven.engine.table.impl.InstrumentedTableUpdateListener

io.deephaven.engine.table.impl.InstrumentedTableUpdateListenerAdapter

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, TableListener, TableUpdateListener, NotificationQueue.Dependency, SystemicObject<InstrumentedTableUpdateListenerAdapter>, Serializable

Direct Known Subclasses:

PythonListenerAdapter, PythonReplayListenerAdapter, ToMapListener

public abstract class InstrumentedTableUpdateListenerAdapter
extends InstrumentedTableUpdateListener
implements SystemicObject<InstrumentedTableUpdateListenerAdapter>

This class is used for ShiftAwareListeners that represent "leaf" nodes in the update propagation tree. It provides an optional retention cache, to prevent listeners from being garbage collected. For creating internally ticking table nodes, instead use BaseTable.ListenerImpl

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.InstrumentedTableUpdateListener

InstrumentedTableUpdateListener.Notification

Nested classes/interfaces inherited from class io.deephaven.engine.table.impl.InstrumentedTableListenerBase

InstrumentedTableListenerBase.ErrorNotification, InstrumentedTableListenerBase.NotificationBase

Nested classes/interfaces inherited from interface io.deephaven.engine.table.TableListener

TableListener.Entry

Field Summary

Fields

Modifier and Type	Field	Description
protected final Table	source

Fields inherited from class io.deephaven.engine.table.impl.InstrumentedTableListenerBase

failed

Constructor Summary

Constructors

Constructor	Description
InstrumentedTableUpdateListenerAdapter(@NotNull Table source, boolean retain)	Create an instrumented listener for source.
InstrumentedTableUpdateListenerAdapter(@Nullable String description, @NotNull Table source, boolean retain)

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(long step)
protected void	destroy()	Attempt to release (destructively when necessary) resources held by this object.
boolean	isSystemicObject()	Returns true if this is a systemically important object (see SystemicObjectTracker).
InstrumentedTableUpdateListenerAdapter	markSystemic()	Mark this object as systemically important.
void	onFailureInternal(Throwable originalException, TableListener.Entry sourceEntry)	Called when the source table produces an error
abstract void	onUpdate(TableUpdate upstream)	Process notification of table changes.

Methods inherited from class io.deephaven.engine.table.impl.InstrumentedTableUpdateListener

getNotification

Methods inherited from class io.deephaven.engine.table.impl.InstrumentedTableListenerBase

append, getEntry, getErrorNotification, getUpdateGraph, onFailure, onFailureInternalWithDependent, satisfied, setVerboseLogging, toString

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

manageWithCurrentScope

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

ensureCleanupOnGC, findAnyManagedReferent, forEachManagedReference, 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

decrementReferenceCount, forceReferenceCountToZero, getReferenceCountDebug, incrementReferenceCount, resetReferenceCount, 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, tryManage, tryUnmanage, tryUnmanage, unmanage, unmanage

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

dropReference, getReferentDescription, getWeakReference, retainReference, tryRetainReference

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

getUpdateGraph

Methods inherited from interface io.deephaven.engine.table.TableListener

getErrorNotification, onFailure

Field Details

source

@ReferentialIntegrity
protected final Table source

Constructor Details

InstrumentedTableUpdateListenerAdapter

public InstrumentedTableUpdateListenerAdapter(@NotNull
 @NotNull Table source,
 boolean retain)

Create an instrumented listener for source. No description is provided.

Parameters:

source - The source table this listener will subscribe to - needed for preserving referential integrity

retain - Whether a hard reference to this listener should be maintained to prevent it from being collected. In most scenarios, it's better to specify false and keep a reference in the calling code.

InstrumentedTableUpdateListenerAdapter

public InstrumentedTableUpdateListenerAdapter(@Nullable
 @Nullable String description,
 @NotNull
 @NotNull Table source,
 boolean retain)

Parameters:

description - A description for the UpdatePerformanceTracker to append to its entry description

source - The source table this listener will subscribe to - needed for preserving referential integrity

retain - Whether a hard reference to this listener should be maintained to prevent it from being collected. In most scenarios, it's better to specify false and keep a reference in the calling code.

Method Details

onUpdate

public abstract void onUpdate(TableUpdate upstream)

Description copied from interface: TableUpdateListener

Process notification of table changes.

The TableUpdateListener onUpdate call executes within the UpdateGraph refresh loop. Any tables used within the listener's onUpdate call must have already been refreshed. Using the typical pattern of a Listener that is listening to a single table, with Table.addUpdateListener(TableUpdateListener), this is trivially true.

When the listener must reference more than just one parent, the tables (or other objects) it references, must be made a NotificationQueue.Dependency of the listener. For listeners that reference multiple ticking tables, a common pattern is to use a MergedListener and collection of ListenerRecorders.

Specified by:

onUpdate in interface TableUpdateListener

Parameters:

upstream - The set of upstream table updates.

onFailureInternal

public void onFailureInternal(Throwable originalException,
 TableListener.Entry sourceEntry)

Called when the source table produces an error

Specified by:

onFailureInternal in class InstrumentedTableListenerBase

Parameters:

originalException - the original throwable that caused this error

sourceEntry - the performance tracker entry that was active when the error occurred

isSystemicObject

public boolean isSystemicObject()

Description copied from interface: SystemicObject

Returns true if this is a systemically important object (see SystemicObjectTracker).

Specified by:

isSystemicObject in interface SystemicObject<InstrumentedTableUpdateListenerAdapter>

Returns:

true if this is a systemically important object, false otherwise.

markSystemic

public InstrumentedTableUpdateListenerAdapter markSystemic()

Description copied from interface: SystemicObject

Mark this object as systemically important.

Specified by:

markSystemic in interface SystemicObject<InstrumentedTableUpdateListenerAdapter>

canExecute

public boolean canExecute(long step)

Overrides:

canExecute in class InstrumentedTableListenerBase

destroy

@OverridingMethodsMustInvokeSuper
protected 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