org.apache.flink.streaming.runtime.tasks

Class OperatorChain<OUT,OP extends StreamOperator<OUT>>

java.lang.Object

org.apache.flink.streaming.runtime.tasks.OperatorChain<OUT,OP>

Type Parameters:

OUT - The type of elements accepted by the chain, i.e., the input type of the chain's head operator.

All Implemented Interfaces:

StreamStatusMaintainer, StreamStatusProvider

@Internal
public class OperatorChain<OUT,OP extends StreamOperator<OUT>>
extends Object
implements StreamStatusMaintainer

The OperatorChain contains all operators that are executed as one chain within a single StreamTask.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OperatorChain.WatermarkGaugeExposingOutput<T> An Output that measures the last emitted watermark with a WatermarkGauge.

Constructor Summary

Constructors

Constructor and Description
OperatorChain(StreamTask<OUT,OP> containingTask, org.apache.flink.runtime.io.network.api.writer.RecordWriterDelegate<org.apache.flink.runtime.plugable.SerializationDelegate<StreamRecord<OUT>>> recordWriterDelegate)

Method Summary

Modifier and Type	Method and Description
void	broadcastCheckpointBarrier(long id, long timestamp, org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions)
void	broadcastCheckpointCancelMarker(long id)
void	endHeadOperatorInput(int inputId) Ends the head operator input specified by inputId).
void	endNonHeadOperatorInput(StreamOperator<?> streamOperator) Ends all inputs of the non-head operator specified by streamOperator) (now there is only one input for each non-head operator).
void	flushOutputs() This method should be called before finishing the record emission, to make sure any data that is still buffered will be sent.
StreamOperator<?>[]	getAllOperators()
OperatorChain.WatermarkGaugeExposingOutput<StreamRecord<OUT>>	getChainEntryPoint()
int	getChainLength()
OP	getHeadOperator()
RecordWriterOutput<?>[]	getStreamOutputs()
StreamStatus	getStreamStatus() Returns the current stream status.
boolean	hasSelectiveReadingOperator()
void	prepareSnapshotPreBarrier(long checkpointId)
void	releaseOutputs() This method releases all resources of the record writer output.
void	toggleStreamStatus(StreamStatus status) Toggles the current stream status.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorChain

public OperatorChain(StreamTask<OUT,OP> containingTask,
                     org.apache.flink.runtime.io.network.api.writer.RecordWriterDelegate<org.apache.flink.runtime.plugable.SerializationDelegate<StreamRecord<OUT>>> recordWriterDelegate)

Method Detail

getStreamStatus

public StreamStatus getStreamStatus()

Description copied from interface: StreamStatusProvider

Returns the current stream status.

Specified by:

getStreamStatus in interface StreamStatusProvider

Returns:

current stream status.

toggleStreamStatus

public void toggleStreamStatus(StreamStatus status)

Description copied from interface: StreamStatusMaintainer

Toggles the current stream status. This method should only have effect if the supplied stream status is different from the current status.

Specified by:

toggleStreamStatus in interface StreamStatusMaintainer

Parameters:

status - the new status to toggle to

broadcastCheckpointBarrier

public void broadcastCheckpointBarrier(long id,
                                       long timestamp,
                                       org.apache.flink.runtime.checkpoint.CheckpointOptions checkpointOptions)
                                throws IOException

Throws:

IOException

broadcastCheckpointCancelMarker

public void broadcastCheckpointCancelMarker(long id)
                                     throws IOException

Throws:

IOException

prepareSnapshotPreBarrier

public void prepareSnapshotPreBarrier(long checkpointId)
                               throws Exception

Throws:

Exception

endHeadOperatorInput

public void endHeadOperatorInput(int inputId)
                          throws Exception

Ends the head operator input specified by inputId).

Parameters:

inputId - the input ID starts from 1 which indicates the first input.

Throws:

Exception

endNonHeadOperatorInput

public void endNonHeadOperatorInput(StreamOperator<?> streamOperator)
                             throws Exception

Ends all inputs of the non-head operator specified by streamOperator) (now there is only one input for each non-head operator).

Parameters:

streamOperator - non-head operator for ending the only input.

Throws:

Exception

getStreamOutputs

public RecordWriterOutput<?>[] getStreamOutputs()

getAllOperators

public StreamOperator<?>[] getAllOperators()

getChainEntryPoint

public OperatorChain.WatermarkGaugeExposingOutput<StreamRecord<OUT>> getChainEntryPoint()

flushOutputs

public void flushOutputs()
                  throws IOException

This method should be called before finishing the record emission, to make sure any data that is still buffered will be sent. It also ensures that all data sending related exceptions are recognized.

Throws:

IOException - Thrown, if the buffered data cannot be pushed into the output streams.

releaseOutputs

public void releaseOutputs()

This method releases all resources of the record writer output. It stops the output flushing thread (if there is one) and releases all buffers currently held by the output serializers.

This method should never fail.

getHeadOperator

public OP getHeadOperator()

getChainLength

public int getChainLength()

hasSelectiveReadingOperator

public boolean hasSelectiveReadingOperator()