akka.io

PipelineStage

abstract class PipelineStage[Context <: PipelineContext, CmdAbove, CmdBelow, EvtAbove, EvtBelow] extends AnyRef

A pipeline stage which can be combined with other stages to build a protocol stack. The main function of this class is to serve as a factory for the actual PipePair generated by the #apply method so that a context object can be passed in.

Self Type
PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]
See also

PipelineFactory

Linear Supertypes
AnyRef, Any
Known Subclasses
BackpressureBuffer, DelimiterFraming, LengthFieldFrame, SslTlsSupport, StringByteStringAdapter, SymmetricPipelineStage, TcpReadWriteAdapter, TickGenerator
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PipelineStage
  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

Instance Constructors

  1. new PipelineStage()

Abstract Value Members

  1. abstract def apply(ctx: Context): PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implement this method to generate this stage’s pair of command and event functions.

    Implement this method to generate this stage’s pair of command and event functions.

    INTERNAL API: do not use this method to instantiate a pipeline!

    Attributes
    protected[akka.io]
    See also

    AbstractSymmetricPipePair

    AbstractPipePair

    PipelineFactory

Concrete 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 PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow], B)

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to ArrowAssoc[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] 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. def >>[CmdBelowBelow, EvtBelowBelow, BelowContext <: Context](right: PipelineStage[_ >: BelowContext, CmdBelow, CmdBelowBelow, EvtBelow, EvtBelowBelow]): PipelineStage[BelowContext, CmdAbove, CmdBelowBelow, EvtAbove, EvtBelowBelow]

    Scala API: attach the two given stages such that the command output of the first is fed into the command input of the second, and the event output of the second is fed into the event input of the first.

    Scala API: attach the two given stages such that the command output of the first is fed into the command input of the second, and the event output of the second is fed into the event input of the first. In other words: sequence the stages such that the left one is on top of the right one.

    right

    the right or lower pipeline stage

    returns

    a pipeline stage representing the sequence of the two stages

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  11. def ensuring(cond: (PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]) ⇒ Boolean, msg: ⇒ Any): PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]) ⇒ Boolean): PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  26. def toString(): String

    Definition Classes
    AnyRef → Any

  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. def |[RightContext <: Context](right: PipelineStage[_ >: RightContext, CmdAbove, CmdBelow, EvtAbove, EvtBelow]): PipelineStage[RightContext, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Scala API: combine the two stages such that the command pipeline of the left stage is used and the event pipeline of the right, discarding the other two sub-pipelines.

    Scala API: combine the two stages such that the command pipeline of the left stage is used and the event pipeline of the right, discarding the other two sub-pipelines.

    right

    the event pipeline

    returns

    a pipeline stage using the left command pipeline and the right event pipeline

  31. def →[B](y: B): (PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow], B)

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to ArrowAssoc[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] 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 PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] 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:
    (pipelineStage: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] 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:
    (pipelineStage: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to ArrowAssoc[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] 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:
    (pipelineStage: ArrowAssoc[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]

    Implicit information
    This member is added by an implicit conversion from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]] 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:
    (pipelineStage: Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]]).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 PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to StringAdd

Inherited by implicit conversion any2stringfmt from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to ArrowAssoc[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]]

Inherited by implicit conversion any2Ensuring from PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipelineStage[Context, CmdAbove, CmdBelow, EvtAbove, EvtBelow]]

Ungrouped