org.apache.flink.streaming.api.functions.source

Class RichParallelSourceFunction<OUT>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.source.RichParallelSourceFunction<OUT>

Type Parameters:

OUT - The type of the records produced by this source.

All Implemented Interfaces:

Serializable, Function, RichFunction, ParallelSourceFunction<OUT>, SourceFunction<OUT>

Direct Known Subclasses:

EventsGeneratorSource, FlinkKafkaConsumerBase, FromSplittableIteratorFunction, InputFormatSourceFunction, NiFiSource, SequenceGeneratorSource, StatefulSequenceSource, StatefulStreamingJob.MySource

@Public
public abstract class RichParallelSourceFunction<OUT>
extends AbstractRichFunction
implements ParallelSourceFunction<OUT>

Base class for implementing a parallel data source. Upon execution, the runtime will execute as many parallel instances of this function as configured parallelism of the source.

The data source has access to context information (such as the number of parallel instances of the source, and which parallel instance the current instance is) via AbstractRichFunction.getRuntimeContext(). It also provides additional life-cycle methods (AbstractRichFunction.open(org.apache.flink.configuration.Configuration) and AbstractRichFunction.close().

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.source.SourceFunction

SourceFunction.SourceContext<T>

Constructor Summary

Constructors

Constructor and Description
RichParallelSourceFunction()

Method Summary

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

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.functions.source.SourceFunction

cancel, run

Constructor Detail

RichParallelSourceFunction

public RichParallelSourceFunction()