t

akka.stream.stage

DetachedContext

trait DetachedContext[Out] extends Context[Out]

Passed to the callback methods of DetachedStage.

#hold stops execution and at the same time putting the stage in a holding state. If the stage is in a holding state it contains one absorbed signal, therefore in this state the only possible command to call is #pushAndPull which results in two events making the balance right again: 1 hold + 1 external event = 2 external event

Source
Stage.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DetachedContext
  2. Context
  3. LifecycleContext
  4. AnyRef
  5. 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 absorbTermination(): TerminationDirective

    Puts the stage in a finishing state so that final elements can be pushed from onPull.

    Puts the stage in a finishing state so that final elements can be pushed from onPull.

    Definition Classes
    Context
  2. abstract def attributes: Attributes

    Returns operation attributes associated with the this Stage

    Returns operation attributes associated with the this Stage

    Definition Classes
    LifecycleContext
  3. abstract def fail(cause: Throwable): FreeDirective

    Cancel upstreams and complete downstreams with failure.

    Cancel upstreams and complete downstreams with failure.

    Definition Classes
    Context
  4. abstract def finish(): FreeDirective

    Cancel upstreams and complete downstreams successfully.

    Cancel upstreams and complete downstreams successfully.

    Definition Classes
    Context
  5. abstract def holdDownstream(): DownstreamDirective
  6. abstract def holdDownstreamAndPull(): DownstreamDirective
  7. abstract def holdUpstream(): UpstreamDirective
  8. abstract def holdUpstreamAndPush(elem: Out): UpstreamDirective
  9. abstract def isFinishing: Boolean

    This returns true after #absorbTermination has been used.

    This returns true after #absorbTermination has been used.

    Definition Classes
    Context
  10. abstract def isHoldingDownstream: Boolean
  11. abstract def isHoldingUpstream: Boolean
  12. abstract def materializer: Materializer

    Returns the Materializer that was used to materialize this Stage.

    Returns the Materializer that was used to materialize this Stage. It can be used to materialize sub-flows.

    Definition Classes
    LifecycleContext
  13. abstract def pull(): UpstreamDirective

    Request for more elements from upstreams.

    Request for more elements from upstreams.

    Definition Classes
    Context
  14. abstract def push(elem: Out): DownstreamDirective

    Push one element to downstreams.

    Push one element to downstreams.

    Definition Classes
    Context
  15. abstract def pushAndFinish(elem: Out): DownstreamDirective

    Push one element to downstream immediately followed by cancel of upstreams and complete of downstreams.

    Push one element to downstream immediately followed by cancel of upstreams and complete of downstreams.

    Definition Classes
    Context
  16. abstract def pushAndPull(elem: Out): FreeDirective

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 DetachedContext[Out] to any2stringadd[DetachedContext[Out]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DetachedContext[Out], B)
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to ArrowAssoc[DetachedContext[Out]] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (DetachedContext[Out]) ⇒ Boolean, msg: ⇒ Any): DetachedContext[Out]
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to Ensuring[DetachedContext[Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (DetachedContext[Out]) ⇒ Boolean): DetachedContext[Out]
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to Ensuring[DetachedContext[Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): DetachedContext[Out]
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to Ensuring[DetachedContext[Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): DetachedContext[Out]
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to Ensuring[DetachedContext[Out]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to StringFormat[DetachedContext[Out]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. def isHoldingBoth: Boolean

    This returns true when #hold has been used and it is reset to false after #pushAndPull.

  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def [B](y: B): (DetachedContext[Out], B)
    Implicit
    This member is added by an implicit conversion from DetachedContext[Out] to ArrowAssoc[DetachedContext[Out]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Context[Out]

Inherited from LifecycleContext

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from DetachedContext[Out] to any2stringadd[DetachedContext[Out]]

Inherited by implicit conversion StringFormat from DetachedContext[Out] to StringFormat[DetachedContext[Out]]

Inherited by implicit conversion Ensuring from DetachedContext[Out] to Ensuring[DetachedContext[Out]]

Inherited by implicit conversion ArrowAssoc from DetachedContext[Out] to ArrowAssoc[DetachedContext[Out]]

Ungrouped