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, AsyncExceptionChecker, OutputTypeConfigurable<OUT>, StreamOperator<OUT>

Direct Known Subclasses:

StoppableStreamSource

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

StreamOperator for streaming sources.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamSource.AutomaticWatermarkContext<T> SourceFunction.SourceContext to be used for sources with automatic timestamps and watermark emission.
static class	StreamSource.ManualWatermarkContext<T> A SourceContext for event time.
static class	StreamSource.NonTimestampContext<T> A source context that attached -1 as a timestamp to all records, and that does not forward watermarks.

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

AbstractStreamOperator.CountingOutput

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, LOG, metrics, output

Constructor Summary

Constructors

Constructor and Description
StreamSource(SRC sourceFunction)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	checkAsyncException() Checks whether any asynchronous thread (checkpoint trigger, timer, watermark generator, ...) has caused an exception.
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)
void	run(Object lockingObject, Output<StreamRecord<OUT>> collector)

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

close, dispose, getUserFunction, getUserFunctionParameters, notifyOfCompletedCheckpoint, open, restoreState, setOutputType, setup, snapshotOperatorState

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

getChainingStrategy, getContainingTask, getCurrentProcessingTime, getExecutionConfig, getMetricGroup, getOperatorConfig, getPartitionedState, getPartitionedState, getRuntimeContext, getStateBackend, getUserCodeClassloader, registerTimer, setChainingStrategy, setKeyContext, setKeyContextElement1, setKeyContextElement2

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

close, dispose, getChainingStrategy, getMetricGroup, notifyOfCompletedCheckpoint, open, restoreState, setChainingStrategy, setKeyContextElement1, setKeyContextElement2, setup, snapshotOperatorState

Constructor Detail

StreamSource

public StreamSource(SRC sourceFunction)

Method Detail

run

public void run(Object lockingObject)
         throws Exception

Throws:

Exception

run

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

Throws:

Exception

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

checkAsyncException

public void checkAsyncException()

Checks whether any asynchronous thread (checkpoint trigger, timer, watermark generator, ...) has caused an exception. If one of these threads caused an exception, this method will throw that exception.

Specified by:

checkAsyncException in interface AsyncExceptionChecker