eventstore.pipeline

LengthFieldFrame

class LengthFieldFrame extends SymmetricPipelineStage[PipelineContext, akka.util.ByteString, akka.util.ByteString]

Pipeline stage for length-field encoded framing. It will prepend a four-byte length header to the message; the header contains the length of the resulting frame including header in big-endian representation.

The maxSize argument is used to protect the communication channel sanity: larger frames will not be sent (silently dropped) or received (in which case stream decoding would be broken, hence throwing an IllegalArgumentException).

Linear Supertypes
SymmetricPipelineStage[PipelineContext, akka.util.ByteString, akka.util.ByteString], PipelineStage[PipelineContext, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LengthFieldFrame
  2. SymmetricPipelineStage
  3. PipelineStage
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LengthFieldFrame(maxSize: Int, byteOrder: ByteOrder = ByteOrder.BIG_ENDIAN, headerSize: Int = 4, lengthIncludesHeader: Boolean = true)

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Definition Classes
    AnyRef → Any
  4. def >>[CmdBelowBelow, EvtBelowBelow, BelowContext <: PipelineContext](right: PipelineStage[_ >: BelowContext, akka.util.ByteString, CmdBelowBelow, akka.util.ByteString, EvtBelowBelow]): PipelineStage[BelowContext, akka.util.ByteString, CmdBelowBelow, akka.util.ByteString, EvtBelowBelow]

    Scala API: attach the two given stages such that the command output of the first is fed into the command input of the second, and the event output of the second is fed into the event input of the first.

    Scala API: attach the two given stages such that the command output of the first is fed into the command input of the second, and the event output of the second is fed into the event input of the first. In other words: sequence the stages such that the left one is on top of the right one.

    right

    the right or lower pipeline stage

    returns

    a pipeline stage representing the sequence of the two stages

    Definition Classes
    PipelineStage
  5. def apply(ctx: PipelineContext): SymmetricPipePair[akka.util.ByteString, akka.util.ByteString]

    Implement this method to generate this stage’s pair of command and event functions.

    Implement this method to generate this stage’s pair of command and event functions.

    INTERNAL API: do not use this method to instantiate a pipeline!

    Definition Classes
    LengthFieldFramePipelineStage
    See also

    AbstractSymmetricPipePair

    AbstractPipePair

    PipelineFactory

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  18. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. def |[RightContext <: PipelineContext](right: PipelineStage[_ >: RightContext, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString]): PipelineStage[RightContext, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString]

    Scala API: combine the two stages such that the command pipeline of the left stage is used and the event pipeline of the right, discarding the other two sub-pipelines.

    Scala API: combine the two stages such that the command pipeline of the left stage is used and the event pipeline of the right, discarding the other two sub-pipelines.

    right

    the event pipeline

    returns

    a pipeline stage using the left command pipeline and the right event pipeline

    Definition Classes
    PipelineStage

Inherited from SymmetricPipelineStage[PipelineContext, akka.util.ByteString, akka.util.ByteString]

Inherited from PipelineStage[PipelineContext, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString, akka.util.ByteString]

Inherited from AnyRef

Inherited from Any

Ungrouped