Trait

akka.stream.javadsl

SourceQueueWithComplete

Related Doc: package javadsl

Permalink

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 any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def complete(): Unit

    Permalink

    Complete the stream normally.

    Complete the stream normally. Use watchCompletion to be notified of this operation’s success.

  2. abstract def fail(ex: Throwable): Unit

    Permalink

    Complete the stream with a failure.

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

  3. abstract def offer(elem: T): CompletionStage[QueueOfferResult]

    Permalink

    Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed or you cannot call offer in this moment because of implementation rules (like for backpressure mode and full buffer you need to wait for last offer call Future completion)

    Method offers next element to a stream and returns future that: - completes with Enqueued if element is consumed by a stream - completes with Dropped when stream dropped offered element - completes with QueueClosed when stream is completed during future is active - completes with Failure(f) when failure to enqueue element from upstream - fails when stream is completed or you cannot call offer in this moment because of implementation rules (like for backpressure mode and full buffer you need to wait for last offer call Future completion)

    elem

    element to send to a stream

    Definition Classes
    SourceQueue
  4. abstract def watchCompletion(): CompletionStage[Done]

    Permalink

    Method returns a Future that will be completed if the stream completes, or will be failed when the stage faces an internal failure or the the SourceQueueWithComplete.fail method is invoked.

    Method returns a Future that will be completed if the stream completes, or will be failed when the stage faces an internal failure or the the SourceQueueWithComplete.fail method is invoked.

    Definition Classes
    SourceQueueWithCompleteSourceQueue

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to any2stringadd[SourceQueueWithComplete[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SourceQueueWithComplete[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to ArrowAssoc[SourceQueueWithComplete[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (SourceQueueWithComplete[T]) ⇒ Boolean, msg: ⇒ Any): SourceQueueWithComplete[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to Ensuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (SourceQueueWithComplete[T]) ⇒ Boolean): SourceQueueWithComplete[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to Ensuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): SourceQueueWithComplete[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to Ensuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): SourceQueueWithComplete[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to Ensuring[SourceQueueWithComplete[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to StringFormat[SourceQueueWithComplete[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (SourceQueueWithComplete[T], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SourceQueueWithComplete[T] to ArrowAssoc[SourceQueueWithComplete[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from SourceQueue[T]

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped