Class

eventstore.pipeline

DelimiterFraming

Related Doc: package pipeline

Permalink

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

Pipeline stage for delimiter byte based framing and de-framing. Useful for string oriented protocol using '\n' or 0 as delimiter values.

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. DelimiterFraming
  2. SymmetricPipelineStage
  3. PipelineStage
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DelimiterFraming(maxSize: Int, delimiter: akka.util.ByteString = ByteString('\n'), includeDelimiter: Boolean = false)

    Permalink

    maxSize

    The maximum size of the frame the pipeline is willing to decode. Not checked for encoding, as the sender might decide to pass through multiple chunks in one go (multiple lines in case of a line-based protocol)

    delimiter

    The sequence of bytes that will be used as the delimiter for decoding.

    includeDelimiter

    If enabled, the delmiter bytes will be part of the decoded messages. In the case of sends the delimiter has to be appended to the end of frames by the user. It is also possible to send multiple frames by embedding multiple delimiters in the passed ByteString

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    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]

    Permalink

    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] { ... /* 2 definitions in type refinement */ }

    Permalink

    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
    DelimiterFraming → PipelineStage
    See also

    AbstractSymmetricPipePair

    AbstractPipePair

    PipelineFactory

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    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]

    Permalink

    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