akka.io

AbstractPipePair

abstract class AbstractPipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] extends AnyRef

Java API: A pair of pipes, one for commands and one for events. Commands travel from top to bottom, events from bottom to top.

See also

PipePairFactory

AbstractSymmetricPipePair

PipelineStage

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

Abstract Value Members

  1. abstract def onCommand(cmd: CmdAbove): Iterable[Either[EvtAbove, CmdBelow]]

    Commands reaching this pipe pair are transformed into a sequence of commands for the next or events for the previous stage.

    Commands reaching this pipe pair are transformed into a sequence of commands for the next or events for the previous stage.

    Throwing exceptions within this method will abort processing of the whole pipeline which this pipe pair is part of.

    cmd

    the incoming command

    returns

    an Iterable of elements which are either events or commands

    See also

    #makeEvent

    #makeCommand

  2. abstract def onEvent(event: EvtBelow): Iterable[Either[EvtAbove, CmdBelow]]

    Events reaching this pipe pair are transformed into a sequence of commands for the next or events for the previous stage.

    Events reaching this pipe pair are transformed into a sequence of commands for the next or events for the previous stage.

    Throwing exceptions within this method will abort processing of the whole pipeline which this pipe pair is part of.

    returns

    an Iterable of elements which are either events or commands

    See also

    #makeEvent

    #makeCommand

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

    Implicit information
    This member is added by an implicit conversion from AbstractPipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] to ArrowAssoc[AbstractPipePair[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 dealias[Cmd, Evt](msg: Iterable[Either[Evt, Cmd]]): Iterable[Either[Evt, Cmd]]

    INTERNAL API: Dealias a possibly optimized return value such that it can be safely used; this is never needed when only using public API.

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from AbstractPipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow] to Ensuring[AbstractPipePair[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 AbstractPipePair[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. def makeCommand(cmd: CmdBelow): Either[EvtAbove, CmdBelow]

    Helper method for wrapping a command which shall be emitted.

  23. def makeEvent(event: EvtAbove): Either[EvtAbove, CmdBelow]

    Helper method for wrapping an event which shall be emitted.

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

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

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

    Definition Classes
    AnyRef
  27. def onManagementCommand(cmd: AnyRef): Iterable[Either[EvtAbove, CmdBelow]]

    Management commands are sent to all stages in a broadcast fashion, conceptually in parallel (but not actually executing a stage reentrantly in case of events or commands being generated in response to a management command).

  28. def singleCommand(cmd: CmdBelow): Iterable[Either[EvtAbove, CmdBelow]]

    Wrap a single command for efficient return to the pipeline’s machinery.

    Wrap a single command for efficient return to the pipeline’s machinery. This method avoids allocating a scala.util.Right and an java.lang.Iterable by reusing one such instance within the AbstractPipePair, hence it can be used ONLY ONCE by each pipeline stage. Prototypic and safe usage looks like this:

    final MyResult result = ... ;
    return singleCommand(result);
    See also

    PipelineContext#singleCommand

  29. def singleEvent(evt: EvtAbove): Iterable[Either[EvtAbove, CmdBelow]]

    Wrap a single event for efficient return to the pipeline’s machinery.

    Wrap a single event for efficient return to the pipeline’s machinery. This method avoids allocating a scala.util.Left and an java.lang.Iterable by reusing one such instance within the AbstractPipePair, hence it can be used ONLY ONCE by each pipeline stage. Prototypic and safe usage looks like this:

    final MyResult result = ... ;
    return singleEvent(result);
    See also

    PipelineContext#singleEvent

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

    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def [B](y: B): (AbstractPipePair[CmdAbove, CmdBelow, EvtAbove, EvtBelow], B)

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

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

Deprecated Value Members

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

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

    (Since version 2.10.0) Use leftOfArrow instead

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

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

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

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

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

Ungrouped