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

Class ContinuousFileMonitoringFunction<OUT>

java.lang.Object

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

org.apache.flink.streaming.api.functions.source.RichSourceFunction<TimestampedFileInputSplit>

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

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, CheckpointedFunction, SourceFunction<TimestampedFileInputSplit>

Deprecated.

This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.

@Deprecated
 @Internal
public class ContinuousFileMonitoringFunction<OUT>
extends RichSourceFunction<TimestampedFileInputSplit>
implements CheckpointedFunction

This is the single (non-parallel) monitoring task which takes a FileInputFormat and, depending on the FileProcessingMode and the FilePathFilter, it is responsible for:

1. Monitoring a user-provided path.
2. Deciding which files should be further read and processed.
3. Creating the splits corresponding to those files.
4. Assigning them to downstream tasks for further processing.

The splits to be read are forwarded to the downstream ContinuousFileReaderOperator which can have parallelism greater than one.

IMPORTANT NOTE: Splits are forwarded downstream for reading in ascending modification time order, based on the modification time of the files they belong to.

See Also:

Serialized Form

Nested Class Summary

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

SourceFunction.SourceContext<T>

Field Summary

Fields

Modifier and Type	Field and Description
static long	MIN_MONITORING_INTERVAL Deprecated. The minimum interval allowed between consecutive path scans.

Constructor Summary

Constructors

Constructor and Description
ContinuousFileMonitoringFunction(org.apache.flink.api.common.io.FileInputFormat<OUT> format, FileProcessingMode watchType, int readerParallelism, long interval) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	cancel() Deprecated. Cancels the source.
void	close() Deprecated.
long	getGlobalModificationTime() Deprecated.
void	initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context) Deprecated. This method is called when the parallel function instance is created during distributed execution.
void	open(org.apache.flink.api.common.functions.OpenContext openContext) Deprecated.
void	run(SourceFunction.SourceContext<TimestampedFileInputSplit> context) Deprecated. Starts the source.
void	snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context) Deprecated. This method is called when a snapshot for a checkpoint is requested.

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

getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

Methods inherited from class java.lang.Object

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

Field Detail

MIN_MONITORING_INTERVAL

public static final long MIN_MONITORING_INTERVAL

Deprecated.

The minimum interval allowed between consecutive path scans.

NOTE: Only applicable to the PROCESS_CONTINUOUSLY mode.

See Also:

Constant Field Values

Constructor Detail

ContinuousFileMonitoringFunction

public ContinuousFileMonitoringFunction(org.apache.flink.api.common.io.FileInputFormat<OUT> format,
                                        FileProcessingMode watchType,
                                        int readerParallelism,
                                        long interval)

Deprecated.

Method Detail

getGlobalModificationTime

@VisibleForTesting
public long getGlobalModificationTime()

Deprecated.

initializeState

public void initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context)
                     throws Exception

Deprecated.

Description copied from interface: CheckpointedFunction

This method is called when the parallel function instance is created during distributed execution. Functions typically set up their state storing data structures in this method.

Specified by:

initializeState in interface CheckpointedFunction

Parameters:

context - the context for initializing the operator

Throws:

Exception - Thrown, if state could not be created ot restored.

open

public void open(org.apache.flink.api.common.functions.OpenContext openContext)
          throws Exception

Deprecated.

Specified by:

open in interface org.apache.flink.api.common.functions.RichFunction

Throws:

Exception

run

public void run(SourceFunction.SourceContext<TimestampedFileInputSplit> context)
         throws Exception

Deprecated.

Description copied from interface: SourceFunction

Starts the source. Implementations use the SourceFunction.SourceContext to emit elements. Sources that checkpoint their state for fault tolerance should use the checkpoint lock to ensure consistency between the bookkeeping and emitting the elements.

Sources that implement CheckpointedFunction must lock on the checkpoint lock checkpoint lock (using a synchronized block) before updating internal state and emitting elements, to make both an atomic operation.

Refer to the top-level class docs for an example.

Specified by:

run in interface SourceFunction<TimestampedFileInputSplit>

Parameters:

context - The context to emit elements to and for accessing locks.

Throws:

Exception

close

public void close()
           throws Exception

Deprecated.

Specified by:

close in interface org.apache.flink.api.common.functions.RichFunction

Overrides:

close in class org.apache.flink.api.common.functions.AbstractRichFunction

Throws:

Exception

cancel

public void cancel()

Deprecated.

Description copied from interface: SourceFunction

Cancels the source. Most sources will have a while loop inside the SourceFunction.run(SourceContext) method. The implementation needs to ensure that the source will break out of that loop after this method is called.

A typical pattern is to have an "volatile boolean isRunning" flag that is set to false in this method. That flag is checked in the loop condition.

In case of an ungraceful shutdown (cancellation of the source operator, possibly for failover), the thread that calls SourceFunction.run(SourceContext) will also be interrupted) by the Flink runtime, in order to speed up the cancellation (to ensure threads exit blocking methods fast, like I/O, blocking queues, etc.). The interruption happens strictly after this method has been called, so any interruption handler can rely on the fact that this method has completed (for example to ignore exceptions that happen after cancellation).

During graceful shutdown (for example stopping a job with a savepoint), the program must cleanly exit the SourceFunction.run(SourceContext) method soon after this method was called. The Flink runtime will NOT interrupt the source thread during graceful shutdown. Source implementors must ensure that no thread interruption happens on any thread that emits records through the SourceContext from the SourceFunction.run(SourceContext) method; otherwise the clean shutdown may fail when threads are interrupted while processing the final records.

Because the SourceFunction cannot easily differentiate whether the shutdown should be graceful or ungraceful, we recommend that implementors refrain from interrupting any threads that interact with the SourceContext at all. You can rely on the Flink runtime to interrupt the source thread in case of ungraceful cancellation. Any additionally spawned threads that directly emit records through the SourceContext should use a shutdown method that does not rely on thread interruption.

Specified by:

cancel in interface SourceFunction<TimestampedFileInputSplit>

snapshotState

public void snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context)
                   throws Exception

Deprecated.

Description copied from interface: CheckpointedFunction

This method is called when a snapshot for a checkpoint is requested. This acts as a hook to the function to ensure that all state is exposed by means previously offered through FunctionInitializationContext when the Function was initialized, or offered now by FunctionSnapshotContext itself.

Specified by:

snapshotState in interface CheckpointedFunction

Parameters:

context - the context for drawing a snapshot of the operator

Throws:

Exception - Thrown, if state could not be created ot restored.