akka.io

PipePair

trait PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] extends AnyRef

Scala API: A pair of pipes, one for commands and one for events, plus a management port. Commands travel from top to bottom, events from bottom to top. All messages which need to be handled “in-order” (e.g. top-down or bottom-up) need to be either events or commands; management messages are processed in no particular order.

Java base classes are provided in the form of AbstractPipePair and AbstractSymmetricPipePair since the Scala function types can be awkward to handle in Java.

See also

PipePairFactory

AbstractSymmetricPipePair

AbstractPipePair

PipelineStage

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. PipePair
  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

Type Members

  1. type Mgmt = PartialFunction[AnyRef, Iterable[Result]]

  2. type Result = Either[EvtAbove, CmdBelow]

Abstract Value Members

  1. abstract def commandPipeline: (CmdAbove) ⇒ Iterable[Result]

    The command pipeline transforms injected commands from the upper stage into commands for the stage below, but it can also emit events for the upper stage.

    The command pipeline transforms injected commands from the upper stage into commands for the stage below, but it can also emit events for the upper stage. Any number of each can be generated.

  2. abstract def eventPipeline: (EvtBelow) ⇒ Iterable[Result]

    The event pipeline transforms injected event from the lower stage into event for the stage above, but it can also emit commands for the stage below.

    The event pipeline transforms injected event from the lower stage into event for the stage above, but it can also emit commands for the stage below. Any number of each can be generated.

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 PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow], B)

    Implicit information
    This member is added by an implicit conversion from PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] to ArrowAssoc[PipePair[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. 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: (PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow]) ⇒ Boolean, msg: ⇒ Any): PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow]

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

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

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

    Implicit information
    This member is added by an implicit conversion from PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow]] 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 PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] 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. def managementPort: Mgmt

    The management port allows sending broadcast messages to all stages within this pipeline.

    The management port allows sending broadcast messages to all stages within this pipeline. This can be used to communicate with stages in the middle without having to thread those messages through the surrounding stages. Each stage can generate events and commands in response to a command, and the aggregation of all those is returned.

    The default implementation ignores all management commands.

  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 [B](y: B): (PipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow], B)

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

    Implicit information
    This member is added by an implicit conversion from PipePair[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:
    (pipePair: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

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

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

    (Since version 2.10.0) Use leftOfArrow instead

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

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

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

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

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

Ungrouped