You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2018/08/20 15:57:49 UTC
[flink] 01/02: [hotfix][streaming][docs] Remove ambiguous remark
about KeyedBroadcastProcessFunction#onTimer()
This is an automated email from the ASF dual-hosted git repository.
chesnay pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit aaa3e215b782b57a1f67f792e853ff25f7864131
Author: Rick Hofstede <ri...@users.noreply.github.com>
AuthorDate: Thu Aug 16 09:32:15 2018 +0200
[hotfix][streaming][docs] Remove ambiguous remark about KeyedBroadcastProcessFunction#onTimer()
It is hard to tell whether "This is aligned with the onTimer()
method of the KeyedProcessFunction" applies to "the ReadOnlyContext
in the processElement() method" or either/both of the sub-items.
Someone not deeply familiar with process functions would simply
assume that `KeyedBroadcastProcessFunction#onTimer` works exactly
like `KeyedProcessFunction#onTimer` anyway, so the removed statement
would be superfluous anyway.
---
docs/dev/stream/state/broadcast_state.md | 2 --
1 file changed, 2 deletions(-)
diff --git a/docs/dev/stream/state/broadcast_state.md b/docs/dev/stream/state/broadcast_state.md
index 593b6a2..b649221 100644
--- a/docs/dev/stream/state/broadcast_state.md
+++ b/docs/dev/stream/state/broadcast_state.md
@@ -172,8 +172,6 @@ exposes some functionality which is not available to the `BroadcastProcessFuncti
`OnTimerContext` which exposes the same functionality as the `ReadOnlyContext` plus
- the ability to ask if the timer that fired was an event or processing time one and
- to query the key associated with the timer.
-
- This is aligned with the `onTimer()` method of the `KeyedProcessFunction`.
2. the `Context` in the `processBroadcastElement()` method contains the method
`applyToKeyedState(StateDescriptor<S, VS> stateDescriptor, KeyedStateFunction<KS, S> function)`. This allows to
register a `KeyedStateFunction` to be **applied to all states of all keys** associated with the provided `stateDescriptor`.