trait SourceQueueWithComplete[T] extends SourceQueue[T]
- Alphabetic
- By Inheritance
- SourceQueueWithComplete
- SourceQueue
- AnyRef
- Any
- by QueueOps
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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.
- 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. - 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 withDropped
when the stream dropped the offered element - completes withQueueClosed
when the stream is completed whilst the Future is active - completes withFailure(f)
in case of failure to enqueue element from upstream - fails when stream is already completedOffers an element to a stream and returns a Future that: - completes with
Enqueued
if the element is consumed by a stream - completes withDropped
when the stream dropped the offered element - completes withQueueClosed
when the stream is completed whilst the Future is active - completes withFailure(f)
in case of failure to enqueue element from upstream - fails when stream is already completedAdditionally 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
- 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
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- 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 org.apache.pekko.stream.scaladsl.SourceQueueWithComplete.
- Definition Classes
- QueueOps
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val queue: SourceQueueWithComplete[T]
- Implicit
- This member is added by an implicit conversion from SourceQueueWithComplete[T] toQueueOps[T] performed by method QueueOps in org.apache.pekko.stream.scaladsl.SourceQueueWithComplete.
- Definition Classes
- QueueOps
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
- Deprecated
- 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
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.