org.apache.flink.streaming.api.functions.co

类 BroadcastProcessFunction<IN1,IN2,OUT>

java.lang.Object

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

org.apache.flink.streaming.api.functions.co.BaseBroadcastProcessFunction

org.apache.flink.streaming.api.functions.co.BroadcastProcessFunction<IN1,IN2,OUT>

类型参数:

IN1 - The input type of the non-broadcast side.

IN2 - The input type of the broadcast side.

OUT - The output type of the operator.

所有已实现的接口:

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

@PublicEvolving
public abstract class BroadcastProcessFunction<IN1,IN2,OUT>
extends BaseBroadcastProcessFunction

A function to be applied to a BroadcastConnectedStream that connects BroadcastStream, i.e. a stream with broadcast state, with a non-keyed DataStream.

The stream with the broadcast state can be created using the DataStream.broadcast(MapStateDescriptor[]) stream.broadcast(MapStateDescriptor)} method.

The user has to implement two methods:

1. the processBroadcastElement(Object, Context, Collector) which will be applied to each element in the broadcast side
2. and the processElement(Object, ReadOnlyContext, Collector) which will be applied to the non-broadcasted/keyed side.

The processElementOnBroadcastSide() takes as argument (among others) a context that allows it to read/write to the broadcast state, while the processElement() has read-only access to the broadcast state.

另请参阅:

序列化表格

嵌套类概要

嵌套类

限定符和类型	类和说明
class	BroadcastProcessFunction.Context A context available to the broadcast side of a BroadcastConnectedStream.
class	BroadcastProcessFunction.ReadOnlyContext A context available to the non-keyed side of a BroadcastConnectedStream (if any).

构造器概要

构造器

构造器和说明
BroadcastProcessFunction()

方法概要

限定符和类型	方法和说明
abstract void	processBroadcastElement(IN2 value, BroadcastProcessFunction.Context ctx, org.apache.flink.util.Collector<OUT> out) This method is called for each element in the broadcast stream.
abstract void	processElement(IN1 value, BroadcastProcessFunction.ReadOnlyContext ctx, org.apache.flink.util.Collector<OUT> out) This method is called for each element in the (non-broadcast) data stream.

从类继承的方法 org.apache.flink.api.common.functions.AbstractRichFunction

close, getIterationRuntimeContext, getRuntimeContext, open, setRuntimeContext

从类继承的方法 java.lang.Object

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

构造器详细资料

BroadcastProcessFunction

public BroadcastProcessFunction()

方法详细资料

processElement

public abstract void processElement(IN1 value,
                                    BroadcastProcessFunction.ReadOnlyContext ctx,
                                    org.apache.flink.util.Collector<OUT> out)
                             throws Exception

This method is called for each element in the (non-broadcast) data stream.

This function can output zero or more elements using the Collector parameter, query the current processing/event time, and also query and update the local keyed state. Finally, it has read-only access to the broadcast state. The context is only valid during the invocation of this method, do not store it.

参数:

value - The stream element.

ctx - A BroadcastProcessFunction.ReadOnlyContext that allows querying the timestamp of the element, querying the current processing/event time and updating the broadcast state. The context is only valid during the invocation of this method, do not store it.

out - The collector to emit resulting elements to

抛出:

Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.

processBroadcastElement

public abstract void processBroadcastElement(IN2 value,
                                             BroadcastProcessFunction.Context ctx,
                                             org.apache.flink.util.Collector<OUT> out)
                                      throws Exception

This method is called for each element in the broadcast stream.

This function can output zero or more elements using the Collector parameter, query the current processing/event time, and also query and update the internal broadcast state. These can be done through the provided BroadcastProcessFunction.Context. The context is only valid during the invocation of this method, do not store it.

参数:

value - The stream element.

ctx - A BroadcastProcessFunction.Context that allows querying the timestamp of the element, querying the current processing/event time and updating the broadcast state. The context is only valid during the invocation of this method, do not store it.

out - The collector to emit resulting elements to

抛出:

Exception - The function may throw exceptions which cause the streaming program to fail and go into recovery.