Packages

t

akka.stream.scaladsl

SourceQueueWithComplete

trait SourceQueueWithComplete[T] extends SourceQueue[T]

This trait adds completion support to SourceQueue.

Source
Queue.scala
Linear Supertypes
SourceQueue[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SourceQueueWithComplete
  2. SourceQueue
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def complete(): Unit

    Complete the stream normally.

    Complete the stream normally. Use watchCompletion to be notified of this operation’s success.

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

  2. abstract def fail(ex: Throwable): Unit

    Complete the stream with a failure.

    Complete the stream with a failure. Use watchCompletion to be notified of this operation’s success.

  3. abstract def offer(elem: T): Future[QueueOfferResult]

    Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed

    Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed

    Additionally when using the backpressure overflowStrategy: - If the buffer is full the Future won't be completed until there is space in the buffer - Calling offer before the Future is completed in this case will return a failed Future

    elem

    element to send to a stream

    Definition Classes
    SourceQueue
  4. abstract def watchCompletion(): Future[Done]

    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.

    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.

    Definition Classes
    SourceQueueWithComplete → SourceQueue