Package org.apache.flink.streaming.api.operators

Class AbstractInput<IN,OUT>

java.lang.Object

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

All Implemented Interfaces:

Input<IN>, KeyContextHandler, AsyncStateProcessing

@Experimental
public abstract class AbstractInput<IN,OUT>
extends Object
implements Input<IN>, KeyContextHandler, AsyncStateProcessing

Base abstract implementation of Input interface intended to be used when extending AbstractStreamOperatorV2.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	inputId
protected Output<StreamRecord<OUT>>	output
protected AbstractStreamOperatorV2<OUT>	owner
protected KeySelector<?,?>	stateKeySelector	KeySelector for extracting a key from an element being processed.

Constructor Summary

Constructors

Constructor	Description
AbstractInput(AbstractStreamOperatorV2<OUT> owner, int inputId)

Method Summary

Modifier and Type	Method	Description
ThrowingConsumer<StreamRecord<IN>,Exception>	getRecordProcessor(int inputId)	Get the record processor that could process record from input, which is the only entry for async processing.
boolean	hasKeyContext()	Whether the Input has "KeyContext".
boolean	isAsyncStateProcessingEnabled()	Get if the async state processing is enabled for this input/operator.
void	processLatencyMarker(LatencyMarker latencyMarker)	Processes a LatencyMarker that arrived on the first input of this two-input operator.
void	processRecordAttributes(RecordAttributes recordAttributes)	Processes a RecordAttributes that arrived at this input.
void	processWatermark(Watermark mark)	Processes a Watermark that arrived on the first input of this two-input operator.
void	processWatermarkStatus(WatermarkStatus watermarkStatus)	Processes a WatermarkStatus that arrived on this input of the MultipleInputStreamOperator.
void	setKeyContextElement(StreamRecord record)	Set the correct key context before processing the record.

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

processElement

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

hasKeyContext1, hasKeyContext2

Field Detail

stateKeySelector

@Nullable
protected final KeySelector<?,?> stateKeySelector

KeySelector for extracting a key from an element being processed. This is used to scope keyed state to a key. This is null if the operator is not a keyed operator.

This is for elements from the first input.

owner

protected final AbstractStreamOperatorV2<OUT> owner

inputId

protected final int inputId

output

protected final Output<StreamRecord<OUT>> output

Constructor Detail

AbstractInput

public AbstractInput(AbstractStreamOperatorV2<OUT> owner,
                     int inputId)

Method Detail

processWatermark

public void processWatermark(Watermark mark)
                      throws Exception

Description copied from interface: Input

Processes a Watermark that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processWatermark in interface Input<IN>

Throws:

Exception

See Also:

Watermark

processLatencyMarker

public void processLatencyMarker(LatencyMarker latencyMarker)
                          throws Exception

Description copied from interface: Input

Processes a LatencyMarker that arrived on the first input of this two-input operator. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processLatencyMarker in interface Input<IN>

Throws:

Exception

See Also:

LatencyMarker

processWatermarkStatus

public void processWatermarkStatus(WatermarkStatus watermarkStatus)
                            throws Exception

Description copied from interface: Input

Processes a WatermarkStatus 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:

processWatermarkStatus in interface Input<IN>

Throws:

Exception

See Also:

WatermarkStatus

setKeyContextElement

public void setKeyContextElement(StreamRecord record)
                          throws Exception

Description copied from interface: Input

Set the correct key context before processing the record. Used for example to extract key from the record and pass that key to the state backends. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

setKeyContextElement in interface Input<IN>

Throws:

Exception

processRecordAttributes

public void processRecordAttributes(RecordAttributes recordAttributes)
                             throws Exception

Description copied from interface: Input

Processes a RecordAttributes that arrived at this input. This method is guaranteed to not be called concurrently with other methods of the operator.

Specified by:

processRecordAttributes in interface Input<IN>

Throws:

Exception

hasKeyContext

public boolean hasKeyContext()

Description copied from interface: KeyContextHandler

Whether the Input has "KeyContext". If false, we can omit the call of Input.setKeyContextElement(org.apache.flink.streaming.runtime.streamrecord.StreamRecord<IN>) for each record.

Specified by:

hasKeyContext in interface KeyContextHandler

Returns:

True if the Input has "KeyContext", false otherwise.

isAsyncStateProcessingEnabled

@Internal
public final boolean isAsyncStateProcessingEnabled()

Description copied from interface: AsyncStateProcessing

Get if the async state processing is enabled for this input/operator.

Specified by:

isAsyncStateProcessingEnabled in interface AsyncStateProcessing

Returns:

ture if async state processing is enabled.

getRecordProcessor

@Internal
public final ThrowingConsumer<StreamRecord<IN>,Exception> getRecordProcessor(int inputId)

Description copied from interface: AsyncStateProcessing

Get the record processor that could process record from input, which is the only entry for async processing.

Specified by:

getRecordProcessor in interface AsyncStateProcessing

Parameters:

inputId - the input identifier, start from 1. Borrow the design from org.apache.flink.streaming.api.operators.AbstractInput#inputId. This is only relevant if there is multiple inputs for the instance.