Package org.apache.flink.streaming.api.operators.async.queue

Interface StreamElementQueueEntry<OUT>

  • All Superinterfaces:
    ResultFuture<OUT>
    All Known Implementing Classes:
    StreamRecordQueueEntry
    @Internal
public interface StreamElementQueueEntry<OUT>
extends ResultFuture<OUT>
    An entry for the StreamElementQueue. The stream element queue entry stores the StreamElement for which the stream element queue entry has been instantiated. Furthermore, it allows to set the result of a completed entry through ResultFuture.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      default void complete​(CollectionSupplier<OUT> supplier)
      The same as complete, but will execute the supplier on the Mailbox thread which initiated the asynchronous process.
      default void completeExceptionally​(Throwable error)
      Not supported.
      void emitResult​(org.apache.flink.streaming.api.operators.TimestampedCollector<OUT> output)
      Emits the results associated with this queue entry.
      org.apache.flink.streaming.runtime.streamrecord.StreamElement getInputElement()
      The input element for this queue entry, for which the calculation is performed asynchronously.
      boolean isDone()
      True if the stream element queue entry has been completed; otherwise false.

    • Method Detail

      • isDone

        boolean isDone()
        True if the stream element queue entry has been completed; otherwise false.
        Returns:
        True if the stream element queue entry has been completed; otherwise false.

      • emitResult

        void emitResult​(org.apache.flink.streaming.api.operators.TimestampedCollector<OUT> output)
        Emits the results associated with this queue entry.
        Parameters:
        output - the output into which to emit.

      • getInputElement

        @Nonnull
org.apache.flink.streaming.runtime.streamrecord.StreamElement getInputElement()
        The input element for this queue entry, for which the calculation is performed asynchronously.
        Returns:
        the input element.

      • completeExceptionally

        default void completeExceptionally​(Throwable error)
        Not supported. Exceptions must be handled in the AsyncWaitOperator.
        Specified by:
        completeExceptionally in interface ResultFuture<OUT>
        Parameters:
        error - A Throwable object.