akka.io

PipelineContext

trait PipelineContext extends AnyRef

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!

See also

AbstractPipelineContext see AbstractPipelineContext for a default implementation (Java)

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

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

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

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

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

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

    Implicit information
    This member is added by an implicit conversion from PipelineContext to Ensuring[PipelineContext] 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 PipelineContext 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. 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.

  24. final def notify(): Unit

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

    Definition Classes
    AnyRef
  26. 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)
    }
    See also

    AbstractPipePair#singleCommand see AbstractPipePair for the Java API

  27. 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)
    }
    See also

    AbstractPipePair#singleEvent see AbstractPipePair for the Java API

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

    Definition Classes
    AnyRef
  29. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def [B](y: B): (PipelineContext, B)

    Implicit information
    This member is added by an implicit conversion from PipelineContext to ArrowAssoc[PipelineContext] 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 PipelineContext 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:
    (pipelineContext: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

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

Deprecated Value Members

  1. def x: PipelineContext

    Implicit information
    This member is added by an implicit conversion from PipelineContext to ArrowAssoc[PipelineContext] 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:
    (pipelineContext: ArrowAssoc[PipelineContext]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: PipelineContext

    Implicit information
    This member is added by an implicit conversion from PipelineContext to Ensuring[PipelineContext] 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:
    (pipelineContext: Ensuring[PipelineContext]).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 PipelineContext to StringAdd

Inherited by implicit conversion any2stringfmt from PipelineContext to StringFormat

Inherited by implicit conversion any2ArrowAssoc from PipelineContext to ArrowAssoc[PipelineContext]

Inherited by implicit conversion any2Ensuring from PipelineContext to Ensuring[PipelineContext]

Ungrouped