org.apache.flink.table.runtime.operators.join.temporal

类 BaseTwoInputStreamOperatorWithStateRetention

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>

org.apache.flink.table.runtime.operators.join.temporal.BaseTwoInputStreamOperatorWithStateRetention

所有已实现的接口:

Serializable, org.apache.flink.runtime.state.CheckpointListener, org.apache.flink.streaming.api.operators.KeyContext, org.apache.flink.streaming.api.operators.SetupableStreamOperator<org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.StreamOperator<org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.StreamOperatorStateHandler.CheckpointedStreamOperator, org.apache.flink.streaming.api.operators.Triggerable<Object,org.apache.flink.runtime.state.VoidNamespace>, org.apache.flink.streaming.api.operators.TwoInputStreamOperator<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>, org.apache.flink.util.Disposable

直接已知子类:

TemporalProcessTimeJoinOperator, TemporalRowTimeJoinOperator

@Internal
public abstract class BaseTwoInputStreamOperatorWithStateRetention
extends org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>
implements org.apache.flink.streaming.api.operators.TwoInputStreamOperator<org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData,org.apache.flink.table.data.RowData>, org.apache.flink.streaming.api.operators.Triggerable<Object,org.apache.flink.runtime.state.VoidNamespace>

An abstract TwoInputStreamOperator that allows its subclasses to clean up their state based on a TTL. This TTL should be specified in the provided minRetentionTime and maxRetentionTime.

For each known key, this operator registers a timer (in processing time) to fire after the TTL expires. When the timer fires, the subclass can decide which state to cleanup and what further action to take.

This class takes care of maintaining at most one timer per key.

IMPORTANT NOTE TO USERS: When extending this class, do not use processing time timers in your business logic. The reason is that:

1) if your timers collide with clean up timers and you delete them, then state clean-up will not be performed, and

2) (this one is the reason why this class does not allow to override the onProcessingTime()) the onProcessingTime with your logic would be also executed on each clean up timer.

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected boolean	stateCleaningEnabled

从类继承的字段 org.apache.flink.streaming.api.operators.AbstractStreamOperator

chainingStrategy, config, latencyStats, LOG, metrics, output, processingTimeService

构造器概要

构造器

限定符	构造器和说明
protected	BaseTwoInputStreamOperatorWithStateRetention(long minRetentionTime, long maxRetentionTime)

方法概要

限定符和类型	方法和说明
protected void	cleanupLastTimer()
abstract void	cleanupState(long time) The method to be called when a cleanup timer fires.
void	onProcessingTime(org.apache.flink.streaming.api.operators.InternalTimer<Object,org.apache.flink.runtime.state.VoidNamespace> timer) The users of this class are not allowed to use processing time timers.
void	open()
protected void	registerProcessingCleanupTimer() If the user has specified a minRetentionTime and maxRetentionTime, this method registers a cleanup timer for currentProcessingTime + minRetentionTime.

从类继承的方法 org.apache.flink.streaming.api.operators.AbstractStreamOperator

close, dispose, getChainingStrategy, getContainingTask, getCurrentKey, getExecutionConfig, getInternalTimerService, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getTimeServiceManager, getUserCodeClassloader, initializeState, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, numEventTimeTimers, numProcessingTimeTimers, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, setProcessingTimeService, setup, snapshotState, snapshotState

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.flink.streaming.api.operators.TwoInputStreamOperator

processElement1, processElement2, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2

从接口继承的方法 org.apache.flink.streaming.api.operators.StreamOperator

close, dispose, getMetricGroup, getOperatorID, initializeState, prepareSnapshotPreBarrier, setKeyContextElement1, setKeyContextElement2, snapshotState

从接口继承的方法 org.apache.flink.runtime.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

从接口继承的方法 org.apache.flink.streaming.api.operators.KeyContext

getCurrentKey, setCurrentKey

从接口继承的方法 org.apache.flink.streaming.api.operators.Triggerable

onEventTime

字段详细资料

stateCleaningEnabled

protected final boolean stateCleaningEnabled

构造器详细资料

BaseTwoInputStreamOperatorWithStateRetention

protected BaseTwoInputStreamOperatorWithStateRetention(long minRetentionTime,
                                                       long maxRetentionTime)

方法详细资料

open

public void open()
          throws Exception

指定者:

open 在接口中 org.apache.flink.streaming.api.operators.StreamOperator<org.apache.flink.table.data.RowData>

覆盖:

open 在类中 org.apache.flink.streaming.api.operators.AbstractStreamOperator<org.apache.flink.table.data.RowData>

抛出:

Exception

registerProcessingCleanupTimer

protected void registerProcessingCleanupTimer()
                                       throws IOException

If the user has specified a minRetentionTime and maxRetentionTime, this method registers a cleanup timer for currentProcessingTime + minRetentionTime.

When this timer fires, the cleanupState(long) method is called.

抛出:

IOException

cleanupLastTimer

protected void cleanupLastTimer()
                         throws IOException

抛出:

IOException

onProcessingTime

public final void onProcessingTime(org.apache.flink.streaming.api.operators.InternalTimer<Object,org.apache.flink.runtime.state.VoidNamespace> timer)
                            throws Exception

The users of this class are not allowed to use processing time timers. See class javadoc.

指定者:

onProcessingTime 在接口中 org.apache.flink.streaming.api.operators.Triggerable<Object,org.apache.flink.runtime.state.VoidNamespace>

抛出:

Exception

cleanupState

public abstract void cleanupState(long time)

The method to be called when a cleanup timer fires.

参数:

time - The timestamp of the fired timer.