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

Class FileSourceFunction<OUT>

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class FileSourceFunction<OUT>
extends RichParallelSourceFunction<OUT>

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
FileSourceFunction(InputFormat<OUT,?> format, TypeInformation<OUT> typeInfo)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the source.
void	close()
InputFormat<OUT,InputSplit>	getFormat() Returns the InputFormat.
void	open(Configuration parameters)
void	run(SourceFunction.SourceContext<OUT> ctx) Starts the source.

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSourceFunction

public FileSourceFunction(InputFormat<OUT,?> format,
                  TypeInformation<OUT> typeInfo)

Method Detail

open

public void open(Configuration parameters)
          throws Exception

Specified by:

open in interface RichFunction

Overrides:

open in class AbstractRichFunction

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception

run

public void run(SourceFunction.SourceContext<OUT> ctx)
         throws Exception

Description copied from interface: SourceFunction

Starts the source. You can use the Collector parameter to emit elements. Sources that implement Checkpointed must lock on the checkpoint lock (using a synchronized block) before updating internal state and/or emitting elements. Also, the update of state and emission of elements must happen in the same synchronized block.

Parameters:

ctx - The context for interaction with the outside world.

Throws:

Exception

cancel

public void cancel()

Description copied from interface: SourceFunction

Cancels the source. Most sources will have a while loop inside the SourceFunction.run(org.apache.flink.streaming.api.functions.source.SourceFunction.SourceContext<T>) method. You need to ensure that the source will break out of this loop. This can be achieved by having a volatile field "isRunning" that is checked in the loop and that is set to false in this method.

getFormat

public InputFormat<OUT,InputSplit> getFormat()

Returns the InputFormat. This is only needed because we need to set the input split assigner on the StreamGraph.