Package org.apache.pekko.stream.scaladsl

Interface SourceQueueWithComplete<T>

All Superinterfaces:
SourceQueue<T>
public interface SourceQueueWithComplete<T> extends SourceQueue<T>
This trait adds completion support to SourceQueue.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    SourceQueueWithComplete.QueueOps<T>
     
    static class 
    SourceQueueWithComplete.QueueOps$
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    complete()
    Completes the stream normally.
    void
    fail(Throwable ex)
    Completes the stream with a failure.
    scala.concurrent.Future<Done>
    watchCompletion()
    Method returns a Future that will be completed if this operator completes, or will be failed when the stream fails, for example when SourceQueueWithComplete.fail is invoked.

    Methods inherited from interface org.apache.pekko.stream.scaladsl.SourceQueue

    offer

  • Method Details

    • complete

      void complete()
      Completes the stream normally. Use watchCompletion to be notified of this operation&rsquo;s success.

      Note that this only means the elements have been passed downstream, not that downstream has successfully processed them.

    • fail

      void fail(Throwable ex)
      Completes the stream with a failure. Use watchCompletion to be notified of this operation&rsquo;s success.

    • watchCompletion

      scala.concurrent.Future<Done> watchCompletion()
      Method returns a Future that will be completed if this operator completes, or will be failed when the stream fails, for example when SourceQueueWithComplete.fail is invoked.

      Note that this only means the elements have been passed downstream, not that downstream has successfully processed them.

      Specified by:
      watchCompletion in interface SourceQueue<T>