SourceFunction API, which is due to be
removed. Use the new Source API instead.@Deprecated @PublicEvolving public class FromSplittableIteratorFunction<T> extends RichParallelSourceFunction<T>
SourceFunction that reads elements from an SplittableIterator and emits them.SourceFunction.SourceContext<T>| Constructor and Description |
|---|
FromSplittableIteratorFunction(SplittableIterator<T> iterator)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
void |
cancel()
Deprecated.
Cancels the source.
|
void |
open(Configuration parameters)
Deprecated.
This method is deprecated since Flink 1.19. The users are recommended to
implement
open(OpenContext openContext) and override open(Configuration
parameters) with an empty body instead. 1. If you implement open(OpenContext
openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be
invoked in the default implementation of the open(OpenContext openContext). |
void |
run(SourceFunction.SourceContext<T> ctx)
Deprecated.
Starts the source.
|
close, getIterationRuntimeContext, getRuntimeContext, setRuntimeContextclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitopenpublic FromSplittableIteratorFunction(SplittableIterator<T> iterator)
@Deprecated public void open(Configuration parameters) throws Exception
open(OpenContext openContext) and override open(Configuration
parameters) with an empty body instead. 1. If you implement open(OpenContext
openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be
invoked in the default implementation of the open(OpenContext openContext).FromSplittableIteratorFunction.open in interface RichFunctionopen in class AbstractRichFunctionparameters - The configuration containing the parameters attached to the contract.Exception - if an error happens.public void run(SourceFunction.SourceContext<T> ctx) throws Exception
SourceFunctionSourceFunction.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.
ctx - The context to emit elements to and for accessing locks.Exceptionpublic void cancel()
SourceFunctionSourceFunction.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.
Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.