Package org.apache.flink.runtime.asyncprocessing.operators

Class AbstractAsyncStateUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>

java.lang.Object

org.apache.flink.streaming.api.operators.AbstractStreamOperator<OUT>

org.apache.flink.runtime.asyncprocessing.operators.AbstractAsyncStateStreamOperator<OUT>

org.apache.flink.runtime.asyncprocessing.operators.AbstractAsyncStateUdfStreamOperator<OUT,F>

Type Parameters:

OUT - The output type of the operator

F - The type of the user function

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.state.CheckpointListener, KeyContext, KeyContextHandler, org.apache.flink.streaming.api.operators.OutputTypeConfigurable<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, UserFunctionProvider<F>, YieldingOperator<OUT>, AsyncStateProcessing, AsyncStateProcessingOperator

Direct Known Subclasses:

AsyncIntervalJoinOperator, AsyncKeyedProcessOperator, AsyncStreamFlatMap, AsyncWindowOperator, StreamGroupedReduceAsyncStateOperator

@Internal
public abstract class AbstractAsyncStateUdfStreamOperator<OUT,F extends org.apache.flink.api.common.functions.Function>
extends AbstractAsyncStateStreamOperator<OUT>
implements org.apache.flink.streaming.api.operators.OutputTypeConfigurable<OUT>, UserFunctionProvider<F>

This is used as the base class for operators that have a user-defined function. This class handles the opening and closing of the user-defined functions, as part of the operator life cycle. This class is nearly identical with AbstractUdfStreamOperator, but extending from AbstractAsyncStateStreamOperator to integrate with asynchronous state access. Another difference is this class is internal.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DeclarationContext	declarationContext
protected final F	userFunction	The user function.

Fields inherited from class org.apache.flink.runtime.asyncprocessing.operators.AbstractAsyncStateStreamOperator

declarationManager

Fields inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

combinedWatermark, config, lastRecordAttributes1, lastRecordAttributes2, latencyStats, metrics, output, processingTimeService, stateHandler, stateKeySelector1, stateKeySelector2, timeServiceManager

Constructor Summary

Constructors

Constructor	Description
AbstractAsyncStateUdfStreamOperator(F userFunction)

Method Summary

Modifier and Type	Method	Description
void	close()	This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.
void	finish()	This method is called at the end of data processing.
F	getUserFunction()	Gets the user function executed in this operator.
void	initializeState(StateInitializationContext context)	Stream operators with state which can be restored need to override this hook method.
void	notifyCheckpointAborted(long checkpointId)
void	notifyCheckpointComplete(long checkpointId)
void	open()	This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.
void	setOutputType(org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo, org.apache.flink.api.common.ExecutionConfig executionConfig)
protected void	setup(StreamTask<?,?> containingTask, StreamConfig config, Output<StreamRecord<OUT>> output)
void	snapshotState(StateSnapshotContext context)	Stream operators with state, which want to participate in a snapshot need to override this hook method.

Methods inherited from class org.apache.flink.runtime.asyncprocessing.operators.AbstractAsyncStateStreamOperator

asyncProcessWithKey, beforeInitializeStateHandler, drainStateRequests, getAsyncKeyedStateBackend, getCurrentKey, getDeclarationManager, getElementOrder, getInternalTimerService, getOrCreateKeyedState, getRecordProcessor, isAsyncStateProcessingEnabled, newKeySelected, postProcessElement, postProcessWatermark, prepareSnapshotPreBarrier, preProcessWatermark, preserveRecordOrderAndProcess, processRecordAttributes, processRecordAttributes1, processRecordAttributes2, processWatermark, processWatermark, processWatermark1, processWatermark1Internal, processWatermark2, processWatermark2Internal, processWatermarkInternal, processWatermarkStatus, processWatermarkStatus, reportOrForwardLatencyMarker, setAsyncKeyedContextElement, setKeyContextElement1, setKeyContextElement2

Methods inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

getContainingTask, getExecutionConfig, getKeyedStateBackend, getKeyedStateStore, getMetricGroup, getOperatorConfig, getOperatorID, getOperatorName, getOperatorStateBackend, getOrCreateKeyedState, getPartitionedState, getPartitionedState, getProcessingTimeService, getRuntimeContext, getStateKeySelector1, getStateKeySelector2, getTimeServiceManager, getUserCodeClassloader, hasKeyContext1, hasKeyContext2, initializeState, isUsingCustomRawKeyedState, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark1, processWatermark2, processWatermarkStatus1, processWatermarkStatus2, setCurrentKey, setMailboxExecutor, setProcessingTimeService, snapshotState, useSplittableTimers

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.streaming.api.operators.KeyContextHandler

hasKeyContext

Methods inherited from interface org.apache.flink.streaming.api.operators.StreamOperator

getOperatorAttributes

Field Details

userFunction

protected final F extends org.apache.flink.api.common.functions.Function userFunction

The user function.

declarationContext

protected transient DeclarationContext declarationContext

Constructor Details

AbstractAsyncStateUdfStreamOperator

public AbstractAsyncStateUdfStreamOperator(F userFunction)

Method Details

getUserFunction

public F getUserFunction()

Gets the user function executed in this operator.

Specified by:

getUserFunction in interface UserFunctionProvider<OUT>

Returns:

The user function of this operator.

setup

protected void setup(StreamTask<?,?> containingTask,
 StreamConfig config,
 Output<StreamRecord<OUT>> output)

Overrides:

setup in class AbstractStreamOperator<OUT>

snapshotState

public void snapshotState(StateSnapshotContext context)
                   throws Exception

Description copied from class: AbstractStreamOperator

Stream operators with state, which want to participate in a snapshot need to override this hook method.

Specified by:

snapshotState in interface StreamOperatorStateHandler.CheckpointedStreamOperator

Overrides:

snapshotState in class AbstractStreamOperator<OUT>

Parameters:

context - context that provides information and means required for taking a snapshot

Throws:

Exception

initializeState

public void initializeState(StateInitializationContext context)
                     throws Exception

Description copied from class: AbstractStreamOperator

Stream operators with state which can be restored need to override this hook method.

Specified by:

initializeState in interface StreamOperatorStateHandler.CheckpointedStreamOperator

Overrides:

initializeState in class AbstractStreamOperator<OUT>

Parameters:

context - context that allows to register different states.

Throws:

Exception

open

public void open()
          throws Exception

Description copied from class: AbstractStreamOperator

This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g. state initialization.

The default implementation does nothing.

Specified by:

open in interface StreamOperator<OUT>

Overrides:

open in class AbstractStreamOperator<OUT>

Throws:

Exception - An exception in this method causes the operator to fail.

finish

public void finish()
            throws Exception

Description copied from interface: StreamOperator

This method is called at the end of data processing.

The method is expected to flush all remaining buffered data. Exceptions during this flushing of buffered data should be propagated, in order to cause the operation to be recognized as failed, because the last data items are not processed properly.

After this method is called, no more records can be produced for the downstream operators.

WARNING: It is not safe to use this method to commit any transactions or other side effects! You can use this method to flush any buffered data that can later on be committed e.g. in a CheckpointListener.notifyCheckpointComplete(long).

NOTE:This method does not need to close any resources. You should release external resources in the StreamOperator.close() method.

Specified by:

finish in interface StreamOperator<OUT>

Overrides:

finish in class AbstractAsyncStateStreamOperator<OUT>

Throws:

Exception - An exception in this method causes the operator to fail.

close

public void close()
           throws Exception

Description copied from interface: StreamOperator

This method is called at the very end of the operator's life, both in the case of a successful completion of the operation, and in the case of a failure and canceling.

This method is expected to make a thorough effort to release all resources that the operator has acquired.

NOTE:It can not emit any records! If you need to emit records at the end of processing, do so in the StreamOperator.finish() method.

Specified by:

close in interface StreamOperator<OUT>

Overrides:

close in class AbstractAsyncStateStreamOperator<OUT>

Throws:

Exception

notifyCheckpointComplete

public void notifyCheckpointComplete(long checkpointId)
                              throws Exception

Specified by:

notifyCheckpointComplete in interface org.apache.flink.api.common.state.CheckpointListener

Overrides:

notifyCheckpointComplete in class AbstractStreamOperator<OUT>

Throws:

Exception

notifyCheckpointAborted

public void notifyCheckpointAborted(long checkpointId)
                             throws Exception

Specified by:

notifyCheckpointAborted in interface org.apache.flink.api.common.state.CheckpointListener

Overrides:

notifyCheckpointAborted in class AbstractStreamOperator<OUT>

Throws:

Exception

setOutputType

public void setOutputType(org.apache.flink.api.common.typeinfo.TypeInformation<OUT> outTypeInfo,
 org.apache.flink.api.common.ExecutionConfig executionConfig)

Specified by:

setOutputType in interface org.apache.flink.streaming.api.operators.OutputTypeConfigurable<OUT>