This is an automated email from the ASF dual-hosted git repository. arvid pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
commit a4d194e4a0981dceb003508a3178c6a4e0ce0e82 Author: Arvid Heise <[email protected]> AuthorDate: Fri Mar 18 16:14:44 2022 +0100 [FLINK-25256][streaming] Clarify the contract of ExternallyInducedSource(Reader). --- .../api/connector/source/ExternallyInducedSourceReader.java | 12 ++++++------ .../streaming/api/checkpoint/ExternallyInducedSource.java | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/flink-core/src/main/java/org/apache/flink/api/connector/source/ExternallyInducedSourceReader.java b/flink-core/src/main/java/org/apache/flink/api/connector/source/ExternallyInducedSourceReader.java index c88bc0f..f26eb84 100644 --- a/flink-core/src/main/java/org/apache/flink/api/connector/source/ExternallyInducedSourceReader.java +++ b/flink-core/src/main/java/org/apache/flink/api/connector/source/ExternallyInducedSourceReader.java @@ -24,16 +24,16 @@ import org.apache.flink.annotation.PublicEvolving; import java.util.Optional; /** - * Sources that implement this interface do not trigger checkpoints when receiving a trigger message - * from the checkpoint coordinator, but when their input data/events indicate that a checkpoint + * Sources that implement this interface delay checkpoints when receiving a trigger message from the + * checkpoint coordinator to the point when their input data/events indicate that a checkpoint * should be triggered. * * <p>The ExternallyInducedSourceReader tells the Flink runtime that a checkpoint needs to be made - * by returning a checkpointId when shouldTriggerCheckpoint() is invoked. + * by returning a checkpointId when {@link #shouldTriggerCheckpoint()} is invoked. * - * <p>The implementations typically works together with the SplitEnumerator which informs the - * external system to trigger a checkpoint. The external system also needs to forward the Checkpoint - * ID to the source, so the source knows which checkpoint to trigger. + * <p>The implementations typically works together with the {@link SplitEnumerator} which informs + * the external system to trigger a checkpoint. The external system also needs to forward the + * Checkpoint ID to the source, so the source knows which checkpoint to trigger. * * <p><b>Important:</b> It is crucial that all parallel source tasks trigger their checkpoints at * roughly the same time. Otherwise this leads to performance issues due to long checkpoint diff --git a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/checkpoint/ExternallyInducedSource.java b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/checkpoint/ExternallyInducedSource.java index eafd307..537a56f 100644 --- a/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/checkpoint/ExternallyInducedSource.java +++ b/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/checkpoint/ExternallyInducedSource.java @@ -23,8 +23,8 @@ import org.apache.flink.streaming.api.functions.source.SourceFunction; import org.apache.flink.util.FlinkException; /** - * Sources that implement this interface do not trigger checkpoints when receiving a trigger message - * from the checkpoint coordinator, but when their input data/events indicate that a checkpoint + * Sources that implement this interface delay checkpoints when receiving a trigger message from the + * checkpoint coordinator to the point when their input data/events indicate that a checkpoint * should be triggered. * * <p>Since sources cannot simply create a new checkpoint on their own, this mechanism always goes
