org.apache.flink.streaming.api.functions.async

Class RichAsyncFunction<IN,OUT>

java.lang.Object

org.apache.flink.api.common.functions.AbstractRichFunction

org.apache.flink.streaming.api.functions.async.RichAsyncFunction<IN,OUT>

Type Parameters:

IN - The type of the input elements.

OUT - The type of the returned elements.

All Implemented Interfaces:

Serializable, Function, RichFunction, AsyncFunction<IN,OUT>

Direct Known Subclasses:

AsyncLookupJoinRunner

@PublicEvolving
public abstract class RichAsyncFunction<IN,OUT>
extends AbstractRichFunction
implements AsyncFunction<IN,OUT>

Rich variant of the AsyncFunction. As a RichFunction, it gives access to the RuntimeContext and provides setup and teardown methods: RichFunction.open(org.apache.flink.configuration.Configuration) and RichFunction.close().

State related apis in RuntimeContext are not supported yet because the key may get changed while accessing states in the working thread.

IterationRuntimeContext.getIterationAggregator(String) is not supported since the aggregator may be modified by multiple threads.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RichAsyncFunction()

Method Summary

Modifier and Type	Method and Description
abstract void	asyncInvoke(IN input, ResultFuture<OUT> resultFuture) Trigger async operation for each stream input.
void	setRuntimeContext(RuntimeContext runtimeContext) Sets the function's runtime context.

Methods inherited from class org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.flink.streaming.api.functions.async.AsyncFunction

timeout

Constructor Detail

RichAsyncFunction

public RichAsyncFunction()

Method Detail

setRuntimeContext

public void setRuntimeContext(RuntimeContext runtimeContext)

Description copied from interface: RichFunction

Sets the function's runtime context. Called by the framework when creating a parallel instance of the function.

Specified by:

setRuntimeContext in interface RichFunction

Overrides:

setRuntimeContext in class AbstractRichFunction

Parameters:

runtimeContext - The runtime context.

asyncInvoke

public abstract void asyncInvoke(IN input,
                                 ResultFuture<OUT> resultFuture)
                          throws Exception

Description copied from interface: AsyncFunction

Trigger async operation for each stream input.

Specified by:

asyncInvoke in interface AsyncFunction<IN,OUT>

Parameters:

input - element coming from an upstream task

resultFuture - to be completed with the result data

Throws:

Exception - in case of a user code error. An exception will make the task fail and trigger fail-over process.