org.apache.flink.streaming.api.operators

Class StreamSource<OUT,SRC extends SourceFunction<OUT>>

java.lang.Object

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

org.apache.flink.streaming.api.operators.AbstractUdfStreamOperator<OUT,SRC>

org.apache.flink.streaming.api.operators.StreamSource<OUT,SRC>

Type Parameters:

OUT - Type of the output elements

SRC - Type of the source function of this stream source operator

All Implemented Interfaces:

Serializable, CheckpointListener, KeyContext, KeyContextHandler, OutputTypeConfigurable<OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, StreamOperatorStateHandler.CheckpointedStreamOperator, UserFunctionProvider<SRC>

@Internal
public class StreamSource<OUT,SRC extends SourceFunction<OUT>>
extends AbstractUdfStreamOperator<OUT,SRC>

StreamOperator for streaming sources.

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
StreamSource(SRC sourceFunction)
StreamSource(SRC sourceFunction, boolean emitProgressiveWatermarks)

Method Summary

Modifier and Type	Method and Description
void	cancel()
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.
boolean	emitsProgressiveWatermarks()
protected boolean	isCanceledOrStopped() Checks whether the source has been canceled or stopped.
protected void	markCanceledOrStopped() Marks this source as canceled or stopped.
void	run(Object lockingObject, OperatorChain<?,?> operatorChain)
void	run(Object lockingObject, Output<StreamRecord<OUT>> collector, OperatorChain<?,?> operatorChain)
void	stop()

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

finish, getUserFunction, getUserFunctionParameters, initializeState, notifyCheckpointAborted, notifyCheckpointComplete, open, 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, hasKeyContext1, hasKeyContext2, initializeState, isUsingCustomRawKeyedState, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, processWatermarkStatus, processWatermarkStatus1, processWatermarkStatus2, 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.KeyContextHandler

hasKeyContext

Constructor Detail

StreamSource

public StreamSource(SRC sourceFunction,
                    boolean emitProgressiveWatermarks)

StreamSource

public StreamSource(SRC sourceFunction)

Method Detail

emitsProgressiveWatermarks

@VisibleForTesting
public boolean emitsProgressiveWatermarks()

run

public void run(Object lockingObject,
                OperatorChain<?,?> operatorChain)
         throws Exception

Throws:

Exception

run

public void run(Object lockingObject,
                Output<StreamRecord<OUT>> collector,
                OperatorChain<?,?> operatorChain)
         throws Exception

Throws:

Exception

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 AbstractUdfStreamOperator<OUT,SRC extends SourceFunction<OUT>>

Throws:

Exception

stop

public void stop()

cancel

public void cancel()

markCanceledOrStopped

protected void markCanceledOrStopped()

Marks this source as canceled or stopped.

This indicates that any exit of the run(Object, Output, OperatorChain) method cannot be interpreted as the result of a finite source.

isCanceledOrStopped

protected boolean isCanceledOrStopped()

Checks whether the source has been canceled or stopped.

Returns:

True, if the source is canceled or stopped, false is not.