Packages

trait SourceQueueWithComplete[T] extends SourceQueue[T]

This trait adds completion support to SourceQueue.

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

Abstract Value Members

  1. abstract def complete(): Unit

    Completes the stream normally.

    Completes 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

    Completes the stream with a failure.

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

  3. 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

    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
    SourceQueueWithCompleteSourceQueue

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 SourceQueueWithComplete[T] toany2stringadd[SourceQueueWithComplete[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SourceQueueWithComplete[T], B)
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toArrowAssoc[SourceQueueWithComplete[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 asJava: javadsl.SourceQueueWithComplete[T]

    Converts the queue into a javadsl.SourceQueueWithComplete

    Converts the queue into a javadsl.SourceQueueWithComplete

    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toQueueOps[T] performed by method QueueOps in akka.stream.scaladsl.SourceQueueWithComplete.
    Definition Classes
    QueueOps
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (SourceQueueWithComplete[T]) => Boolean, msg: => Any): SourceQueueWithComplete[T]
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toEnsuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (SourceQueueWithComplete[T]) => Boolean): SourceQueueWithComplete[T]
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toEnsuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): SourceQueueWithComplete[T]
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toEnsuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): SourceQueueWithComplete[T]
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toEnsuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toStringFormat[SourceQueueWithComplete[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val queue: SourceQueueWithComplete[T]
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toQueueOps[T] performed by method QueueOps in akka.stream.scaladsl.SourceQueueWithComplete.
    Definition Classes
    QueueOps
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (SourceQueueWithComplete[T], B)
    Implicit
    This member is added by an implicit conversion from SourceQueueWithComplete[T] toArrowAssoc[SourceQueueWithComplete[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 SourceQueue[T]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion QueueOps fromSourceQueueWithComplete[T] to QueueOps[T]

Inherited by implicit conversion any2stringadd fromSourceQueueWithComplete[T] to any2stringadd[SourceQueueWithComplete[T]]

Inherited by implicit conversion StringFormat fromSourceQueueWithComplete[T] to StringFormat[SourceQueueWithComplete[T]]

Inherited by implicit conversion Ensuring fromSourceQueueWithComplete[T] to Ensuring[SourceQueueWithComplete[T]]

Inherited by implicit conversion ArrowAssoc fromSourceQueueWithComplete[T] to ArrowAssoc[SourceQueueWithComplete[T]]

Ungrouped