Package io.deephaven.engine.table.impl

Class OperationSnapshotControlEx

java.lang.Object

io.deephaven.engine.table.impl.OperationSnapshotControl

io.deephaven.engine.table.impl.OperationSnapshotControlEx

All Implemented Interfaces:

ConstructSnapshot.SnapshotCompletedConsistently, ConstructSnapshot.SnapshotConsistent, ConstructSnapshot.SnapshotControl, ConstructSnapshot.UsePreviousValues

public final class OperationSnapshotControlEx
extends OperationSnapshotControl

Variant of OperationSnapshotControl that considers an "extra" NotificationStepSource in addition to the source BaseTable when determining whether to use previous values during initialization or evaluating success. This is useful anytime an operation needs to listen to and snapshot one data source while also snapshotting another.

Constructor Summary

Constructors

Constructor	Description
OperationSnapshotControlEx(@NotNull BaseTable<?> sourceTable, @NotNull NotificationStepSource extra)

Method Summary

Modifier and Type	Method	Description
protected boolean	isInInitialNotificationWindow()
void	setListenerAndResult(TableUpdateListener listener, @NotNull NotificationStepReceiver resultTable)	Set the listener that will eventually become the listener, if we have a successful snapshot.
boolean	snapshotCompletedConsistently(long afterClockValue, boolean usedPreviousValues)	Ends a snapshot.
Boolean	usePreviousValues(long beforeClockValue)	Starts a snapshot.

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

getUpdateGraph, snapshotConsistent

Methods inherited from class java.lang.Object

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

Constructor Details

OperationSnapshotControlEx

public OperationSnapshotControlEx(@NotNull
 @NotNull BaseTable<?> sourceTable,
 @NotNull
 @NotNull NotificationStepSource extra)

Method Details

usePreviousValues

public Boolean usePreviousValues(long beforeClockValue)

Description copied from class: OperationSnapshotControl

Starts a snapshot.

Specified by:

usePreviousValues in interface ConstructSnapshot.UsePreviousValues

Overrides:

usePreviousValues in class OperationSnapshotControl

Parameters:

beforeClockValue - the logical clock value we are starting a snapshot on

Returns:

true if we should use previous values, false if we should use current values.

snapshotCompletedConsistently

public boolean snapshotCompletedConsistently(long afterClockValue,
 boolean usedPreviousValues)

Description copied from class: OperationSnapshotControl

Ends a snapshot. Overriding methods must call super in order to ensure that the result's last notification step is properly set.

Specified by:

snapshotCompletedConsistently in interface ConstructSnapshot.SnapshotCompletedConsistently

Specified by:

snapshotCompletedConsistently in interface ConstructSnapshot.SnapshotControl

Overrides:

snapshotCompletedConsistently in class OperationSnapshotControl

Parameters:

afterClockValue - The logical clock cycle we are ending a snapshot on

usedPreviousValues - Whether we used previous values during the snapshot

Returns:

true if the snapshot was successful, false if we should try again.

setListenerAndResult

public void setListenerAndResult(TableUpdateListener listener,
 @NotNull
 @NotNull NotificationStepReceiver resultTable)

Description copied from class: OperationSnapshotControl

Set the listener that will eventually become the listener, if we have a successful snapshot.

Overrides:

setListenerAndResult in class OperationSnapshotControl

Parameters:

listener - The listener that we will eventually forward all updates to

resultTable - The table that will result from this operation

isInInitialNotificationWindow

protected boolean isInInitialNotificationWindow()

Overrides:

isInInitialNotificationWindow in class OperationSnapshotControl

Returns:

Whether we are in the initial notification window and can continue with the snapshot