Class SequenceGeneratorSource
- java.lang.Object
-
- org.apache.flink.api.common.functions.AbstractRichFunction
-
- org.apache.flink.streaming.api.functions.source.legacy.RichParallelSourceFunction<Event>
-
- org.apache.flink.streaming.tests.SequenceGeneratorSource
-
- All Implemented Interfaces:
Serializable
,Function
,RichFunction
,CheckpointedFunction
,ParallelSourceFunction<Event>
,SourceFunction<Event>
@Internal public class SequenceGeneratorSource extends RichParallelSourceFunction<Event> implements CheckpointedFunction
Deprecated.This class is based on theSourceFunction
API, which is due to be removed. Use the newSource
API instead.This source function generates a sequence of long values per key.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.flink.streaming.api.functions.source.legacy.SourceFunction
SourceFunction.SourceContext<T>
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
cancel()
Deprecated.Cancels the source.void
initializeState(FunctionInitializationContext context)
Deprecated.This method is called when the parallel function instance is created during distributed execution.void
run(SourceFunction.SourceContext<Event> ctx)
Deprecated.Starts the source.void
snapshotState(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
close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext
-
-
-
-
Method Detail
-
run
public void run(SourceFunction.SourceContext<Event> ctx) throws Exception
Deprecated.Description copied from interface:SourceFunction
Starts the source. Implementations use theSourceFunction.SourceContext
to emit elements. Sources that checkpoint their state for fault tolerance should use thecheckpoint lock
to ensure consistency between the bookkeeping and emitting the elements.Sources that implement
CheckpointedFunction
must lock on thecheckpoint 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 interfaceSourceFunction<Event>
- Parameters:
ctx
- The context to emit elements to and for accessing locks.- Throws:
Exception
-
cancel
public void cancel()
Deprecated.Description copied from interface:SourceFunction
Cancels the source. Most sources will have a while loop inside theSourceFunction.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 tofalse
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 beinterrupted
) 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 theSourceContext
from theSourceFunction.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 theSourceContext
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 theSourceContext
should use a shutdown method that does not rely on thread interruption.- Specified by:
cancel
in interfaceSourceFunction<Event>
-
snapshotState
public void snapshotState(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 throughFunctionInitializationContext
when the Function was initialized, or offered now byFunctionSnapshotContext
itself.- Specified by:
snapshotState
in interfaceCheckpointedFunction
- Parameters:
context
- the context for drawing a snapshot of the operator- Throws:
Exception
- Thrown, if state could not be created ot restored.
-
initializeState
public void initializeState(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 interfaceCheckpointedFunction
- Parameters:
context
- the context for initializing the operator- Throws:
Exception
- Thrown, if state could not be created ot restored.
-
-