Package org.apache.pekko.stream

Interface BoundedSourceQueue<T>

  • public interface BoundedSourceQueue<T>
    A queue of the given size that gives immediate feedback whether an element could be enqueued or not.

    Not for user extension

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void complete()
      Completes the stream normally.
      void fail​(java.lang.Throwable ex)
      Completes the stream with a failure.
      boolean isCompleted()
      Returns true if the stream has been completed, either normally or with failure.
      QueueOfferResult offer​(T elem)
      Returns a pekko.stream.QueueOfferResult that notifies the caller if the element could be enqueued or not, or the completion status of the queue.
      int size()
      Returns the approximate number of elements in this queue.

    • Method Detail

      • complete

        void complete()
        Completes the stream normally.

      • fail

        void fail​(java.lang.Throwable ex)
        Completes the stream with a failure.

      • isCompleted

        boolean isCompleted()
        Returns true if the stream has been completed, either normally or with failure.

        Since:
        1.1.0

      • offer

        QueueOfferResult offer​(T elem)
        Returns a pekko.stream.QueueOfferResult that notifies the caller if the element could be enqueued or not, or the completion status of the queue.

        A result of QueueOfferResult.Enqueued does not guarantee that an element also has been or will be processed by the downstream.

      • size

        int size()
        Returns the approximate number of elements in this queue.