akka.stream.stage

Stage

sealed trait Stage[-In, Out] extends AnyRef

General interface for stream transformation.

Custom Stage implementations are intended to be used with akka.stream.scaladsl.FlowOps#transform or akka.stream.javadsl.Flow#transform to extend the Flow API when there is no specialized operator that performs the transformation.

Custom implementations are subclasses of PushPullStage or DetachedStage. Sometimes it is convenient to extend StatefulStage for support of become like behavior.

It is possible to keep state in the concrete Stage instance with ordinary instance variables. The Transformer is executed by an actor and therefore you do not have to add any additional thread safety or memory visibility constructs to access the state from the callback methods.

Source
Stage.scala
See also

akka.stream.javadsl.Flow#transform

akka.stream.scaladsl.Flow#transform

Linear Supertypes
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Stage
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Stage[In, Out], B)

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to ArrowAssoc[Stage[In, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (Stage[In, Out]) ⇒ Boolean, msg: ⇒ Any): Stage[In, Out]

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to Ensuring[Stage[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Stage[In, Out]) ⇒ Boolean): Stage[In, Out]

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to Ensuring[Stage[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): Stage[In, Out]

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to Ensuring[Stage[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Stage[In, Out]

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to Ensuring[Stage[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

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

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  25. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (Stage[In, Out], B)

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to ArrowAssoc[Stage[In, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (stage: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (stage: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Stage[In, Out]

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to ArrowAssoc[Stage[In, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (stage: ArrowAssoc[Stage[In, Out]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Stage[In, Out]

    Implicit information
    This member is added by an implicit conversion from Stage[In, Out] to Ensuring[Stage[In, Out]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (stage: Ensuring[Stage[In, Out]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Stage[In, Out] to StringAdd

Inherited by implicit conversion any2stringfmt from Stage[In, Out] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Stage[In, Out] to ArrowAssoc[Stage[In, Out]]

Inherited by implicit conversion any2Ensuring from Stage[In, Out] to Ensuring[Stage[In, Out]]

Ungrouped