Mailing-List: contact issues-help@flink.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@flink.apache.org
Date: Sat, 9 Dec 2017 17:27:01 +0000 (UTC)
From: "ASF GitHub Bot (JIRA)" <jira@apache.org>
To: issues@flink.apache.org
Message-ID: <JIRA.13119694.1511192716000.424555.1512840421633@Atlassian.JIRA>
In-Reply-To: <JIRA.13119694.1511192716000@Atlassian.JIRA>
References: <JIRA.13119694.1511192716000@Atlassian.JIRA> <JIRA.13119694.1511192716802@jira-lw-us.apache.org>
Subject: [jira] [Commented] (FLINK-8116) Stale comments referring to
 Checkpointed interface
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Sat, 09 Dec 2017 17:27:11 -0000


    [ https://issues.apache.org/jira/browse/FLINK-8116?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16284847#comment-16284847 ] 

ASF GitHub Bot commented on FLINK-8116:
---------------------------------------

Github user ggevay commented on a diff in the pull request:

    https://github.com/apache/flink/pull/5121#discussion_r155927615
  
    --- Diff: flink-streaming-java/src/main/java/org/apache/flink/streaming/api/functions/source/SourceFunction.java ---
    @@ -34,17 +34,17 @@
      * The run method can run for as long as necessary. The source must, however, react to an
      * invocation of {@link #cancel()} by breaking out of its main loop.
      *
    - * <h3>Checkpointed Sources</h3>
    + * <h3>CheckpointedFunction Sources</h3>
      *
    - * <p>Sources that also implement the {@link org.apache.flink.streaming.api.checkpoint.Checkpointed}
    + * <p>Sources that also implement the {@link org.apache.flink.streaming.api.checkpoint.CheckpointedFunction}
      * interface must ensure that state checkpointing, updating of internal state and emission of
      * elements are not done concurrently. This is achieved by using the provided checkpointing lock
      * object to protect update of state and emission of elements in a synchronized block.
      *
      * <p>This is the basic pattern one should follow when implementing a (checkpointed) source:
      *
      * <pre>{@code
    - *  public class ExampleSource<T> implements SourceFunction<T>, Checkpointed<Long> {
    + *  public class ExampleSource<T> implements SourceFunction<T>, CheckpointedFunction<Long> {
    --- End diff --
    
    You can see the function bodies here:
    https://ci.apache.org/projects/flink/flink-docs-release-1.4/dev/stream/state/state.html#stateful-source-functions


> Stale comments referring to Checkpointed interface
> --------------------------------------------------
>
>                 Key: FLINK-8116
>                 URL: https://issues.apache.org/jira/browse/FLINK-8116
>             Project: Flink
>          Issue Type: Bug
>          Components: DataStream API, Documentation
>            Reporter: Gabor Gevay
>            Priority: Trivial
>              Labels: starter
>             Fix For: 1.5.0
>
>
> Between Flink 1.1 and 1.2, the {{Checkpointed}} interface was superseded by the {{CheckpointedFunction}} interface.
> However, in {{SourceFunction}} there are two comments still referring to the old {{Checkpointed}} interface. (The code examples there also need to be modified.)
> Note that the problem also occurs in {{StreamExecutionEnvironment}}, and possibly other places as well.


--
This message was sent by Atlassian JIRA
(v6.4.14#64029)