[
https://issues.apache.org/jira/browse/FLINK-5026?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15701728#comment-15701728
]
ASF GitHub Bot commented on FLINK-5026:
---------------------------------------
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.
> Rename TimelyFlatMap to Process
> -------------------------------
>
> Key: FLINK-5026
> URL: https://issues.apache.org/jira/browse/FLINK-5026
> Project: Flink
> Issue Type: Improvement
> Components: Streaming
> Reporter: Aljoscha Krettek
> Assignee: Aljoscha Krettek
> Fix For: 1.2.0
>
>
> The method on {{KeyedDataStream}} would be called {{process()}} and the
> function itself would be called {{ProcessFunction}}.
> The reason for this is that {{TimelyFlatMapFunction}} is a bit of a mouthful
> and with the additions to the timer API and state the {{ProcessFunction}}
> could become the basic, low-level, user-facing API for cases where users
> nowadays implement their own operator.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
