Package io.deephaven.integrations.python

Class PythonReplayListenerAdapter

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

io.deephaven.integrations.python.PythonReplayListenerAdapter

All Implemented Interfaces:

LogOutputAppendable, LivenessManager, LivenessNode, LivenessReferent, TableListener, TableUpdateListener, NotificationQueue.Dependency, TableSnapshotReplayer, Serializable

@ScriptApi
public class PythonReplayListenerAdapter
extends InstrumentedTableUpdateListenerAdapter
implements TableSnapshotReplayer

A Deephaven table listener which passes update events to a Python listener object. The listener can also replay the current table snapshot. The Python listener object can be either (1) a callable or (2) an object which provides an "onUpdate" method. In either case, the method must take two arguments (isReplay, updates).

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 inherited from class io.deephaven.engine.table.impl.InstrumentedTableUpdateListenerAdapter

source

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

failed

Method Summary

Modifier and Type	Method	Description
boolean	canExecute(long step)
static PythonReplayListenerAdapter	create(String description, @NotNull Table source, boolean retain, @NotNull org.jpy.PyObject pyListener, @NotNull org.jpy.PyObject pyOnFailureCallback, NotificationQueue.Dependency... dependencies)	Create a Python listener.
boolean	isFailed()
void	onFailureInternal(Throwable originalException, TableListener.Entry sourceEntry)	Called when the source table produces an error
void	onUpdate(TableUpdate update)	Process notification of table changes.
void	replay()	Replay the current table snapshot into a listener.

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

destroy

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

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

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

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

Method Details

create

public static PythonReplayListenerAdapter create(@Nullable
 String description,
 @NotNull
 @NotNull Table source,
 boolean retain,
 @NotNull
 @NotNull org.jpy.PyObject pyListener,
 @NotNull
 @NotNull org.jpy.PyObject pyOnFailureCallback,
 @Nullable
 NotificationQueue.Dependency... dependencies)

Create a Python listener.

Parameters:

description - A description for the UpdatePerformanceTracker to append to its entry description, may be null.

source - The source table to which this listener will subscribe.

retain - Whether a hard reference to this listener should be maintained to prevent it from being collected.

pyListener - Python listener object.

dependencies - The tables that must be satisfied before this listener is executed.

replay

public void replay()

Description copied from interface: TableSnapshotReplayer

Replay the current table snapshot into a listener. A shared or exclusive UGP lock should be held when calling this method.

Specified by:

replay in interface TableSnapshotReplayer

onUpdate

public void onUpdate(TableUpdate update)

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

Specified by:

onUpdate in class InstrumentedTableUpdateListenerAdapter

Parameters:

update - The set of upstream table updates.

onFailureInternal

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

Description copied from class: InstrumentedTableUpdateListenerAdapter

Called when the source table produces an error

Overrides:

onFailureInternal in class InstrumentedTableUpdateListenerAdapter

Parameters:

originalException - the original throwable that caused this error

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

canExecute

public boolean canExecute(long step)

Overrides:

canExecute in class InstrumentedTableUpdateListenerAdapter

isFailed

public boolean isFailed()