org.apache.flink.table.runtime.operators.calc.async

Class AsyncFunctionRunner

java.lang.Object

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

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

org.apache.flink.table.runtime.operators.calc.async.AsyncFunctionRunner

All Implemented Interfaces:

Serializable, Function, RichFunction, AsyncFunction<RowData,RowData>

public class AsyncFunctionRunner
extends RichAsyncFunction<RowData,RowData>

Async function runner for AsyncScalarFunction, which takes the generated function, instantiates it, and then calls its lifecycle methods.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AsyncFunctionRunner(GeneratedFunction<AsyncFunction<RowData,RowData>> generatedFetcher)

Method Summary

Modifier and Type	Method and Description
void	asyncInvoke(RowData input, ResultFuture<RowData> resultFuture) Trigger async operation for each stream input.
void	close() Tear-down method for the user code.
void	open(OpenContext openContext) Initialization method for the function.

Methods inherited from class org.apache.flink.streaming.api.functions.async.RichAsyncFunction

setRuntimeContext

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

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

AsyncFunctionRunner

public AsyncFunctionRunner(GeneratedFunction<AsyncFunction<RowData,RowData>> generatedFetcher)

Method Detail

open

public void open(OpenContext openContext)
          throws Exception

Description copied from interface: RichFunction

Initialization method for the function. It is called before the actual working methods (like map or join) and thus suitable for one time setup work. For functions that are part of an iteration, this method will be invoked at the beginning of each iteration superstep.

The openContext object passed to the function can be used for configuration and initialization. The openContext contains some necessary information that were configured on the function in the program composition.

 public class MyFilter extends RichFilterFunction<String> {

     private String searchString;

     public void open(OpenContext openContext) {
         // initialize the value of searchString
     }

     public boolean filter(String value) {
         return value.equals(searchString);
     }
 }
 

By default, this method does nothing.

1. If you implement open(OpenContext openContext), the open(OpenContext openContext) will be invoked and the open(Configuration parameters) won't be invoked. 2. If you don't implement open(OpenContext openContext), the open(Configuration parameters) will be invoked in the default implementation of the open(OpenContext openContext).

Parameters:

openContext - The context containing information about the context in which the function is opened.

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.

asyncInvoke

public void asyncInvoke(RowData input,
                        ResultFuture<RowData> resultFuture)

Description copied from interface: AsyncFunction

Trigger async operation for each stream input.

Specified by:

asyncInvoke in interface AsyncFunction<RowData,RowData>

Specified by:

asyncInvoke in class RichAsyncFunction<RowData,RowData>

Parameters:

input - element coming from an upstream task

resultFuture - to be completed with the result data

close

public void close()
           throws Exception

Description copied from interface: RichFunction

Tear-down method for the user code. It is called after the last call to the main working methods (e.g. map or join). For functions that are part of an iteration, this method will be invoked after each iteration superstep.

This method can be used for clean up work.

Specified by:

close in interface RichFunction

Overrides:

close in class AbstractRichFunction

Throws:

Exception - Implementations may forward exceptions, which are caught by the runtime. When the runtime catches an exception, it aborts the task and lets the fail-over logic decide whether to retry the task execution.