akka.io

AbstractSymmetricPipePair

abstract class AbstractSymmetricPipePair[Above, Below] extends AbstractPipePair[Above, Below, Above, Below]

A convenience type for expressing a AbstractPipePair which has the same types for commands and events.

Linear Supertypes
AbstractPipePair[Above, Below, Above, Below], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AbstractSymmetricPipePair
  2. AbstractPipePair
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractSymmetricPipePair()

Abstract Value Members

  1. abstract def onCommand(cmd: Above): Iterable[Either[Above, Below]]

    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

    Definition Classes
    AbstractPipePair
    See also

    #makeEvent

    #makeCommand

  2. abstract def onEvent(event: Below): Iterable[Either[Above, Below]]

    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

    Definition Classes
    AbstractPipePair
    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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    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 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.

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

    Definition Classes
    AbstractPipePair
  9. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  15. def makeCommand(cmd: Below): Either[Above, Below]

    Helper method for wrapping a command which shall be emitted.

    Helper method for wrapping a command which shall be emitted.

    Definition Classes
    AbstractPipePair
  16. def makeEvent(event: Above): Either[Above, Below]

    Helper method for wrapping an event which shall be emitted.

    Helper method for wrapping an event which shall be emitted.

    Definition Classes
    AbstractPipePair
  17. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  20. def onManagementCommand(cmd: AnyRef): Iterable[Either[Above, Below]]

    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).

    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).

    Definition Classes
    AbstractPipePair
  21. def singleCommand(cmd: Below): Iterable[Either[Above, Below]]

    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);
    Definition Classes
    AbstractPipePair
    See also

    PipelineContext#singleCommand

  22. def singleEvent(evt: Above): Iterable[Either[Above, Below]]

    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);
    Definition Classes
    AbstractPipePair
    See also

    PipelineContext#singleEvent

  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( ... )

Inherited from AbstractPipePair[Above, Below, Above, Below]

Inherited from AnyRef

Inherited from Any

Ungrouped