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, org.apache.flink.runtime.state.CheckpointListener, KeyContext, OutputTypeConfigurable<OUT>, SetupableStreamOperator<OUT>, StreamOperator<OUT>, org.apache.flink.util.Disposable

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

StreamOperator for streaming sources.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.streaming.api.operators.AbstractStreamOperator

AbstractStreamOperator.CountingOutput<OUT>

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, timeServiceManager

Constructor Summary

Constructors

Constructor and Description
StreamSource(SRC sourceFunction)

Method Summary

Modifier and Type	Method and Description
void	advanceToEndOfEventTime()
void	cancel()
void	close() This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).
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, StreamStatusMaintainer streamStatusMaintainer, OperatorChain<?,?> operatorChain)
void	run(Object lockingObject, StreamStatusMaintainer streamStatusMaintainer, Output<StreamRecord<OUT>> collector, OperatorChain<?,?> operatorChain)

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

dispose, getUserFunction, getUserFunctionParameters, initializeState, 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, getUserCodeClassloader, initializeState, numEventTimeTimers, numProcessingTimeTimers, prepareSnapshotPreBarrier, processLatencyMarker, processLatencyMarker1, processLatencyMarker2, processWatermark, processWatermark1, processWatermark2, reportOrForwardLatencyMarker, setChainingStrategy, setCurrentKey, setKeyContextElement1, setKeyContextElement2, snapshotState

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamSource

public StreamSource(SRC sourceFunction)

Method Detail

run

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

Throws:

Exception

run

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

Throws:

Exception

advanceToEndOfEventTime

public void advanceToEndOfEventTime()

close

public void close()
           throws Exception

Description copied from class: AbstractStreamOperator

This method is called after all records have been added to the operators via the methods OneInputStreamOperator.processElement(StreamRecord), or TwoInputStreamOperator.processElement1(StreamRecord) and TwoInputStreamOperator.processElement2(StreamRecord).

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

Specified by:

close in interface StreamOperator<OUT>

Overrides:

close in class AbstractUdfStreamOperator<OUT,SRC extends SourceFunction<OUT>>

Throws:

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

cancel

public void cancel()

markCanceledOrStopped

protected void markCanceledOrStopped()

Marks this source as canceled or stopped.

This indicates that any exit of the #run(Object, StreamStatusMaintainer, Output) 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.