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:
io.deephaven.base.log.LogOutputAppendable, io.deephaven.engine.liveness.LivenessManager, io.deephaven.engine.liveness.LivenessNode, io.deephaven.engine.liveness.LivenessReferent, io.deephaven.engine.table.TableListener, io.deephaven.engine.table.TableUpdateListener, io.deephaven.engine.updategraph.NotificationQueue.Dependency, TableSnapshotReplayer, Serializable
@ScriptApi public class PythonReplayListenerAdapter extends io.deephaven.engine.table.impl.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:

  • Nested Class Summary

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

    io.deephaven.engine.table.impl.InstrumentedTableUpdateListener.Notification

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

    io.deephaven.engine.table.impl.InstrumentedTableListenerBase.ErrorNotification, io.deephaven.engine.table.impl.InstrumentedTableListenerBase.NotificationBase

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

    io.deephaven.engine.table.TableListener.Entry

  • Field Summary

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

    source

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canExecute(long step)
     
    static PythonReplayListenerAdapter
    create(String description, io.deephaven.engine.table.Table source, boolean retain, org.jpy.PyObject pyObjectIn, io.deephaven.engine.updategraph.NotificationQueue.Dependency... dependencies)
    Create a Python listener.
    void
    onUpdate(io.deephaven.engine.table.TableUpdate update)
     
    void
    replay()
    Replay the current table snapshot into a listener.

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

    destroy, onFailureInternal

    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, io.deephaven.engine.table.Table source, boolean retain, org.jpy.PyObject pyObjectIn, io.deephaven.engine.updategraph.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.
      pyObjectIn - 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(io.deephaven.engine.table.TableUpdate update)
      Specified by:
      onUpdate in interface io.deephaven.engine.table.TableUpdateListener
      Specified by:
      onUpdate in class io.deephaven.engine.table.impl.InstrumentedTableUpdateListenerAdapter

    • canExecute

      public boolean canExecute(long step)
      Overrides:
      canExecute in class io.deephaven.engine.table.impl.InstrumentedTableUpdateListenerAdapter