Packages

t

akka.stream.scaladsl

SourceQueue

trait SourceQueue[T] extends AnyRef

This trait allows to have a queue as a data source for some stream.

Source
Queue.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
SourceQueueWithComplete
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SourceQueue
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

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

    Offers an element to a stream and returns a Future that: - completes with Enqueued if the element is consumed by a stream - completes with Dropped when the stream dropped the offered element - completes with QueueClosed when the stream is completed whilst the Future is active - completes with Failure(f) in case of failure to enqueue element from upstream - fails when stream is already completed

    Offers an element to a stream and returns a Future that: - completes with Enqueued if the element is consumed by a stream - completes with Dropped when the stream dropped the offered element - completes with QueueClosed when the stream is completed whilst the Future is active - completes with Failure(f) in case of failure to enqueue element from upstream - fails when stream is already 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 it will return a failed Future

    elem

    element to send to a stream

  2. abstract def watchCompletion(): Future[Done]

    Returns a Future that will be completed if this operator completes, or will be failed when the operator faces an internal failure.

    Returns a Future that will be completed if this operator completes, or will be failed when the operator faces an internal failure.

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