org.apache.flink.streaming.api.operators

Class KeyedProcessOperator<K,IN,OUT>

java.lang.Object

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

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,KeyedProcessFunction<K,IN,OUT>>

org.apache.flink.streaming.api.operators.KeyedProcessOperator<K,IN,OUT>

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.state.CheckpointListener, Input<IN>, KeyContext, OneInputStreamOperator<IN,OUT>, OutputTypeConfigurable<OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, Triggerable<K,org.apache.flink.runtime.state.VoidNamespace>, org.apache.flink.util.Disposable

@Internal
public class KeyedProcessOperator<K,IN,OUT>
extends AbstractUdfStreamOperator<OUT,KeyedProcessFunction<K,IN,OUT>>
implements OneInputStreamOperator<IN,OUT>, Triggerable<K,org.apache.flink.runtime.state.VoidNamespace>

A StreamOperator for executing KeyedProcessFunctions.

See Also:

Serialized Form

Field Summary

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

userFunction

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

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

Constructor Summary

Constructors

Constructor and Description
KeyedProcessOperator(KeyedProcessFunction<K,IN,OUT> function)

Method Summary

Modifier and Type	Method and Description
void	onEventTime(InternalTimer<K,org.apache.flink.runtime.state.VoidNamespace> timer) Invoked when an event-time timer fires.
void	onProcessingTime(InternalTimer<K,org.apache.flink.runtime.state.VoidNamespace> timer) Invoked when a processing-time timer fires.
void	open() This method is called immediately before any elements are processed, it should contain the operator's initialization logic, e.g.
void	processElement(StreamRecord<IN> element) Processes one element that arrived on this input of the MultipleInputStreamOperator.

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

close, dispose, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, setOutputType, setup, snapshotState

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

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

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.OneInputStreamOperator

setKeyContextElement

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

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

Methods inherited from interface org.apache.flink.api.common.state.CheckpointListener

notifyCheckpointAborted, notifyCheckpointComplete

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

getCurrentKey, setCurrentKey

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

processLatencyMarker, processWatermark

Constructor Detail

KeyedProcessOperator

public KeyedProcessOperator(KeyedProcessFunction<K,IN,OUT> function)

Method Detail

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 AbstractUdfStreamOperator<OUT,KeyedProcessFunction<K,IN,OUT>>

Throws:

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

onEventTime

public void onEventTime(InternalTimer<K,org.apache.flink.runtime.state.VoidNamespace> timer)
                 throws Exception

Description copied from interface: Triggerable

Invoked when an event-time timer fires.

Specified by:

onEventTime in interface Triggerable<K,org.apache.flink.runtime.state.VoidNamespace>

Throws:

Exception

onProcessingTime

public void onProcessingTime(InternalTimer<K,org.apache.flink.runtime.state.VoidNamespace> timer)
                      throws Exception

Description copied from interface: Triggerable

Invoked when a processing-time timer fires.

Specified by:

onProcessingTime in interface Triggerable<K,org.apache.flink.runtime.state.VoidNamespace>

Throws:

Exception

processElement

public void processElement(StreamRecord<IN> element)
                    throws Exception

Description copied from interface: Input

Processes one element that arrived on this input of the MultipleInputStreamOperator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processElement in interface Input<IN>

Throws:

Exception