Packages

trait SinkQueueWithCancel[T] extends SinkQueue[T]

This trait adds cancel support to SinkQueue.

Source
Queue.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SinkQueueWithCancel
  2. SinkQueue
  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 cancel(): Unit

    Cancels the stream.

    Cancels the stream. This method returns right away without waiting for actual finalizing the stream.

  2. abstract def pull(): Future[Option[T]]

    Pulls elements from the stream and returns a Future that: - fails if the stream is failed - completes with None in case the stream is completed - completes with Some(element) in case the next element is available from stream.

    Pulls elements from the stream and returns a Future that: - fails if the stream is failed - completes with None in case the stream is completed - completes with Some(element) in case the next element is available from stream.

    Definition Classes
    SinkQueue

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 SinkQueueWithCancel[T] toany2stringadd[SinkQueueWithCancel[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SinkQueueWithCancel[T], B)
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toArrowAssoc[SinkQueueWithCancel[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.SinkQueueWithCancel[T]
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toQueueOps[T] performed by method QueueOps in akka.stream.scaladsl.SinkQueueWithCancel.
    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: (SinkQueueWithCancel[T]) => Boolean, msg: => Any): SinkQueueWithCancel[T]
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toEnsuring[SinkQueueWithCancel[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (SinkQueueWithCancel[T]) => Boolean): SinkQueueWithCancel[T]
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toEnsuring[SinkQueueWithCancel[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): SinkQueueWithCancel[T]
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toEnsuring[SinkQueueWithCancel[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): SinkQueueWithCancel[T]
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toEnsuring[SinkQueueWithCancel[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 SinkQueueWithCancel[T] toStringFormat[SinkQueueWithCancel[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: SinkQueueWithCancel[T]
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toQueueOps[T] performed by method QueueOps in akka.stream.scaladsl.SinkQueueWithCancel.
    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): (SinkQueueWithCancel[T], B)
    Implicit
    This member is added by an implicit conversion from SinkQueueWithCancel[T] toArrowAssoc[SinkQueueWithCancel[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 SinkQueue[T]

Inherited from AnyRef

Inherited from Any

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

Inherited by implicit conversion any2stringadd fromSinkQueueWithCancel[T] to any2stringadd[SinkQueueWithCancel[T]]

Inherited by implicit conversion StringFormat fromSinkQueueWithCancel[T] to StringFormat[SinkQueueWithCancel[T]]

Inherited by implicit conversion Ensuring fromSinkQueueWithCancel[T] to Ensuring[SinkQueueWithCancel[T]]

Inherited by implicit conversion ArrowAssoc fromSinkQueueWithCancel[T] to ArrowAssoc[SinkQueueWithCancel[T]]

Ungrouped