org.apache.flink.streaming.api.functions.source

类 MultipleIdsMessageAcknowledgingSourceBase<Type,UId,SessionId>

java.lang.Object

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

org.apache.flink.streaming.api.functions.source.RichSourceFunction<Type>

org.apache.flink.streaming.api.functions.source.MessageAcknowledgingSourceBase<Type,UId>

org.apache.flink.streaming.api.functions.source.MultipleIdsMessageAcknowledgingSourceBase<Type,UId,SessionId>

类型参数:

Type - The type of the messages created by the source.

UId - The type of the unique IDs which are consistent across sessions.

SessionId - The type of the IDs that are used for acknowledging elements (ids valid during session).

所有已实现的接口:

Serializable, org.apache.flink.api.common.functions.Function, org.apache.flink.api.common.functions.RichFunction, org.apache.flink.api.common.state.CheckpointListener, CheckpointedFunction, SourceFunction<Type>

已过时。

This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.

@Deprecated
 @PublicEvolving
public abstract class MultipleIdsMessageAcknowledgingSourceBase<Type,UId,SessionId>
extends MessageAcknowledgingSourceBase<Type,UId>

Abstract base class for data sources that receive elements from a message queue and acknowledge them back by IDs. In contrast to MessageAcknowledgingSourceBase, this source handles two types of ids:

1. Session ids
2. Unique message ids

Session ids are used to acknowledge messages in a session. When a checkpoint is restored, unacknowledged messages are redelivered. Duplicates are detected using the unique message ids which are checkpointed.

另请参阅:

序列化表格

嵌套类概要

从接口继承的嵌套类/接口 org.apache.flink.streaming.api.functions.source.SourceFunction

SourceFunction.SourceContext<T>

字段概要

字段

限定符和类型	字段和说明
protected List<SessionId>	sessionIds 已过时。
protected Deque<org.apache.flink.api.java.tuple.Tuple2<Long,List<SessionId>>>	sessionIdsPerSnapshot 已过时。

从类继承的字段 org.apache.flink.streaming.api.functions.source.MessageAcknowledgingSourceBase

pendingCheckpoints

构造器概要

构造器

限定符	构造器和说明
protected	MultipleIdsMessageAcknowledgingSourceBase(Class<UId> idClass) 已过时。 Creates a new MessageAcknowledgingSourceBase for IDs of the given type.
protected	MultipleIdsMessageAcknowledgingSourceBase(org.apache.flink.api.common.typeinfo.TypeInformation<UId> idTypeInfo) 已过时。 Creates a new MessageAcknowledgingSourceBase for IDs of the given type.

方法概要

限定符和类型	方法和说明
protected void	acknowledgeIDs(long checkpointId, Set<UId> uniqueIds) 已过时。 Acknowledges the session ids.
protected abstract void	acknowledgeSessionIDs(List<SessionId> sessionIds) 已过时。 Acknowledges the session ids.
void	close() 已过时。
void	open(org.apache.flink.configuration.Configuration parameters) 已过时。 This method is deprecated since Flink 1.19. The users are recommended to implement open(OpenContext openContext) and override open(Configuration parameters) with an empty body instead. 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).
void	snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context) 已过时。 This method is called when a snapshot for a checkpoint is requested.

从类继承的方法 org.apache.flink.streaming.api.functions.source.MessageAcknowledgingSourceBase

addId, initializeState, notifyCheckpointAborted, notifyCheckpointComplete

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

getIterationRuntimeContext, getRuntimeContext, setRuntimeContext

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

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

从接口继承的方法 org.apache.flink.streaming.api.functions.source.SourceFunction

cancel, run

从接口继承的方法 org.apache.flink.api.common.functions.RichFunction

open

字段详细资料

sessionIdsPerSnapshot

protected transient Deque<org.apache.flink.api.java.tuple.Tuple2<Long,List<SessionId>>> sessionIdsPerSnapshot

已过时。

sessionIds

protected transient List<SessionId> sessionIds

已过时。

构造器详细资料

MultipleIdsMessageAcknowledgingSourceBase

protected MultipleIdsMessageAcknowledgingSourceBase(Class<UId> idClass)

已过时。

Creates a new MessageAcknowledgingSourceBase for IDs of the given type.

参数:

idClass - The class of the message ID type, used to create a serializer for the message IDs.

MultipleIdsMessageAcknowledgingSourceBase

protected MultipleIdsMessageAcknowledgingSourceBase(org.apache.flink.api.common.typeinfo.TypeInformation<UId> idTypeInfo)

已过时。

Creates a new MessageAcknowledgingSourceBase for IDs of the given type.

参数:

idTypeInfo - The type information of the message ID type, used to create a serializer for the message IDs.

方法详细资料

open

@Deprecated
public void open(org.apache.flink.configuration.Configuration parameters)
                      throws Exception

已过时。 This method is deprecated since Flink 1.19. The users are recommended to implement open(OpenContext openContext) and override open(Configuration parameters) with an empty body instead. 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).

Initialization method for the MultipleIdsMessageAcknowledgingSourceBase.

指定者:

open 在接口中 org.apache.flink.api.common.functions.RichFunction

覆盖:

open 在类中 org.apache.flink.api.common.functions.AbstractRichFunction

参数:

parameters - The configuration containing the parameters attached to the contract.

抛出:

Exception - if an error happens.

另请参阅:

FLIP-344: Remove parameter in RichFunction#open

close

public void close()
           throws Exception

已过时。

指定者:

close 在接口中 org.apache.flink.api.common.functions.RichFunction

覆盖:

close 在类中 MessageAcknowledgingSourceBase<Type,UId>

抛出:

Exception

acknowledgeIDs

protected final void acknowledgeIDs(long checkpointId,
                                    Set<UId> uniqueIds)

已过时。

Acknowledges the session ids.

指定者:

acknowledgeIDs 在类中 MessageAcknowledgingSourceBase<Type,UId>

参数:

checkpointId - The id of the current checkout to acknowledge ids for.

uniqueIds - The checkpointed unique ids which are ignored here. They only serve as a means of de-duplicating messages when the acknowledgment after a checkpoint fails.

acknowledgeSessionIDs

protected abstract void acknowledgeSessionIDs(List<SessionId> sessionIds)

已过时。

Acknowledges the session ids.

参数:

sessionIds - The message ids for this session.

snapshotState

public void snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context)
                   throws Exception

已过时。

从接口复制的说明: CheckpointedFunction

This method is called when a snapshot for a checkpoint is requested. This acts as a hook to the function to ensure that all state is exposed by means previously offered through FunctionInitializationContext when the Function was initialized, or offered now by FunctionSnapshotContext itself.

指定者:

snapshotState 在接口中 CheckpointedFunction

覆盖:

snapshotState 在类中 MessageAcknowledgingSourceBase<Type,UId>

参数:

context - the context for drawing a snapshot of the operator

抛出:

Exception - Thrown, if state could not be created ot restored.