Mailing-List: contact issues-help@flink.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@flink.apache.org
From: kl0u <git@git.apache.org>
To: issues@flink.incubator.apache.org
Reply-To: issues@flink.incubator.apache.org
References: <git-pr-2788-flink@git.apache.org>
In-Reply-To: <git-pr-2788-flink@git.apache.org>
Subject: [GitHub] flink pull request #2788: [FLINK-5026] Rename TimelyFlatMap to Process
Content-Type: text/plain
Message-Id: <20161128112648.69E74EFE5E@git1-us-west.apache.org>
Date: Mon, 28 Nov 2016 11:26:48 +0000 (UTC)
archived-at: Mon, 28 Nov 2016 11:26:54 -0000

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

    https://github.com/apache/flink/pull/2788#discussion_r89760102
  
    --- Diff: flink-streaming-java/src/main/java/org/apache/flink/streaming/api/functions/ProcessFunction.java ---
    @@ -24,32 +24,24 @@
     import org.apache.flink.streaming.api.TimerService;
     import org.apache.flink.util.Collector;
     
    -import java.io.Serializable;
    -
     /**
    - * Base interface for timely flatMap functions. FlatMap functions take elements and transform them,
    - * into zero, one, or more elements. Typical applications can be splitting elements, or unnesting lists
    - * and arrays.
    - *
    - * <p>A {@code TimelyFlatMapFunction} can, in addition to the functionality of a normal
    - * {@link org.apache.flink.api.common.functions.FlatMapFunction}, also set timers and react
    - * to them firing.
    + * A function that processes elements of a stream.
      *
    - * <pre>{@code
    - * DataStream<X> input = ...;
    - *
    - * DataStream<Y> result = input.flatMap(new MyTimelyFlatMapFunction());
    - * }</pre>
    + * <p>The function will be called for every element in the input stream and can produce
    + * zero or more output. The function can also query the time and set timers. When
    + * reacting to the firing of set timers the function can emit yet more elements.
      *
    --- End diff --
    
    <p>The function will be called for every element in the input stream and can produce
     * zero or more output elements. Contrary to the {@link org.apache.flink.api.common.functions.FlatMapFunction},
     * this function can also query the time (both event and processing) and set timers,
     * through the provided {@link Context}. When reacting to the firing of set timers the function can
     * directly emit a result, and/or register a timer that will trigger an action in the future.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---