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

Class MultipleIdsMessageAcknowledgingSourceBase<Type,​UId,​SessionId>

  • Type Parameters:
    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).
    All Implemented Interfaces:
    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>
    @Deprecated
@PublicEvolving
public abstract class MultipleIdsMessageAcknowledgingSourceBase<Type,​UId,​SessionId>
extends MessageAcknowledgingSourceBase<Type,​UId>
    Deprecated.
    This class is based on the SourceFunction API, which is due to be removed. Use the new Source API instead.
    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.

    See Also:
    Serialized Form

    • Field Detail

      • sessionIdsPerSnapshot

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

      • sessionIds

        protected transient List<SessionId> sessionIds
        Deprecated.

    • Constructor Detail

      • MultipleIdsMessageAcknowledgingSourceBase

        protected MultipleIdsMessageAcknowledgingSourceBase​(Class<UId> idClass)
        Deprecated.
        Creates a new MessageAcknowledgingSourceBase for IDs of the given type.
        Parameters:
        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)
        Deprecated.
        Creates a new MessageAcknowledgingSourceBase for IDs of the given type.
        Parameters:
        idTypeInfo - The type information of the message ID type, used to create a serializer for the message IDs.

    • Method Detail

      • open

        @Deprecated
public void open​(org.apache.flink.configuration.Configuration parameters)
          throws Exception
        Deprecated.
        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.
        Specified by:
        open in interface org.apache.flink.api.common.functions.RichFunction
        Overrides:
        open in class org.apache.flink.api.common.functions.AbstractRichFunction
        Parameters:
        parameters - The configuration containing the parameters attached to the contract.
        Throws:
        Exception - if an error happens.
        See Also:
        FLIP-344: Remove parameter in RichFunction#open

      • acknowledgeIDs

        protected final void acknowledgeIDs​(long checkpointId,
                                    Set<UId> uniqueIds)
        Deprecated.
        Acknowledges the session ids.
        Specified by:
        acknowledgeIDs in class MessageAcknowledgingSourceBase<Type,​UId>
        Parameters:
        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)
        Deprecated.
        Acknowledges the session ids.
        Parameters:
        sessionIds - The message ids for this session.

      • snapshotState

        public void snapshotState​(org.apache.flink.runtime.state.FunctionSnapshotContext context)
                   throws Exception
        Deprecated.
        Description copied from interface: 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.
        Specified by:
        snapshotState in interface CheckpointedFunction
        Overrides:
        snapshotState in class MessageAcknowledgingSourceBase<Type,​UId>
        Parameters:
        context - the context for drawing a snapshot of the operator
        Throws:
        Exception - Thrown, if state could not be created ot restored.