akka.io

AbstractPipelineContext

abstract class AbstractPipelineContext extends PipelineContext

This base trait of each pipeline’s context provides optimized facilities for generating single commands or events (i.e. the fast common case of 1:1 message transformations).

IMPORTANT NOTICE:

A PipelineContext MUST NOT be shared between multiple pipelines, it contains mutable state without synchronization. You have been warned!

Linear Supertypes
PipelineContext, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AbstractPipelineContext
  2. PipelineContext
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AbstractPipelineContext()

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
    PipelineContext
  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. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def nothing[Cmd, Evt]: Iterable[Either[Evt, Cmd]]

    A shared (and shareable) instance of an empty Iterable[Either[EvtAbove, CmdBelow]].

    A shared (and shareable) instance of an empty Iterable[Either[EvtAbove, CmdBelow]]. Use this when processing does not yield any commands or events as result.

    Definition Classes
    PipelineContext
  17. final def notify(): Unit

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

    Definition Classes
    AnyRef
  19. def singleCommand[Cmd <: AnyRef, Evt <: AnyRef](cmd: Cmd): Iterable[Either[Evt, Cmd]]

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

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

    override val commandPipeline = { cmd =>
    val myResult = ...
    ctx.singleCommand(myResult)
    }
    Definition Classes
    PipelineContext
    See also

    AbstractPipePair#singleCommand see AbstractPipePair for the Java API

  20. def singleEvent[Cmd <: AnyRef, Evt <: AnyRef](evt: Evt): Iterable[Either[Evt, Cmd]]

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

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

    override val eventPipeline = { cmd =>
    val myResult = ...
    ctx.singleEvent(myResult)
    }
    Definition Classes
    PipelineContext
    See also

    AbstractPipePair#singleEvent see AbstractPipePair for the Java API

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

    Definition Classes
    AnyRef
  22. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PipelineContext

Inherited from AnyRef

Inherited from Any

Ungrouped