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
Known Subclasses
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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toany2stringadd[SourceQueue[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SourceQueue[T], B)
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toArrowAssoc[SourceQueue[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (SourceQueue[T]) => Boolean, msg: => Any): SourceQueue[T]
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toEnsuring[SourceQueue[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (SourceQueue[T]) => Boolean): SourceQueue[T]
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toEnsuring[SourceQueue[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): SourceQueue[T]
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toEnsuring[SourceQueue[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): SourceQueue[T]
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toEnsuring[SourceQueue[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toStringFormat[SourceQueue[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (SourceQueue[T], B)
    Implicit
    This member is added by an implicit conversion from SourceQueue[T] toArrowAssoc[SourceQueue[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSourceQueue[T] to any2stringadd[SourceQueue[T]]

Inherited by implicit conversion StringFormat fromSourceQueue[T] to StringFormat[SourceQueue[T]]

Inherited by implicit conversion Ensuring fromSourceQueue[T] to Ensuring[SourceQueue[T]]

Inherited by implicit conversion ArrowAssoc fromSourceQueue[T] to ArrowAssoc[SourceQueue[T]]

Ungrouped