Package org.apache.flink.runtime.asyncprocessing.operators.windowing.functions

Interface InternalAsyncWindowFunction<IN,OUT,KEY,W extends Window>

Type Parameters:

IN - The type of the input value from async window state query. Note: for iterable inputs, this may be a StateIterator.

OUT - The type of the output value.

KEY - The type of the key.

All Superinterfaces:

org.apache.flink.api.common.functions.Function, Serializable

All Known Implementing Classes:

InternalAggregateProcessAsyncWindowFunction, InternalIterableAsyncWindowFunction, InternalIterableProcessAsyncWindowFunction, InternalSingleValueAsyncWindowFunction, InternalSingleValueProcessAsyncWindowFunction

public interface InternalAsyncWindowFunction<IN,OUT,KEY,W extends Window>
extends org.apache.flink.api.common.functions.Function

Internal interface for functions that are evaluated over keyed (grouped) windows. This is for async window operator.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	InternalAsyncWindowFunction.InternalWindowContext	A context for InternalAsyncWindowFunction, similar to ProcessWindowFunction.Context but for internal use.

Method Summary

Modifier and Type	Method	Description
org.apache.flink.api.common.state.v2.StateFuture<Void>	clear(W window, InternalAsyncWindowFunction.InternalWindowContext context)	Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).
org.apache.flink.api.common.state.v2.StateFuture<Void>	process(KEY key, W window, InternalAsyncWindowFunction.InternalWindowContext context, IN input, org.apache.flink.util.Collector<OUT> out)	Evaluates the window and outputs none or several elements.

Method Detail

process

org.apache.flink.api.common.state.v2.StateFuture<Void> process(KEY key,
                                                               W window,
                                                               InternalAsyncWindowFunction.InternalWindowContext context,
                                                               IN input,
                                                               org.apache.flink.util.Collector<OUT> out)
                                                        throws Exception

Evaluates the window and outputs none or several elements.

Parameters:

context - The context in which the window is being evaluated.

input - The elements in the window being evaluated.

out - A collector for emitting elements.

Returns:

Throws:

Exception - The function may throw exceptions to fail the program and trigger recovery.

clear

org.apache.flink.api.common.state.v2.StateFuture<Void> clear(W window,
                                                             InternalAsyncWindowFunction.InternalWindowContext context)
                                                      throws Exception

Deletes any state in the Context when the Window expires (the watermark passes its maxTimestamp + allowedLateness).

Parameters:

context - The context to which the window is being evaluated

Throws:

Exception - The function may throw exceptions to fail the program and trigger recovery.