akka.io

DelimiterFraming

class DelimiterFraming extends SymmetricPipelineStage[PipelineContext, ByteString, 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
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DelimiterFraming
  2. SymmetricPipelineStage
  3. PipelineStage
  4. AnyRef
  5. 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

Instance Constructors

  1. new DelimiterFraming(maxSize: Int, delimiter: ByteString = ..., includeDelimiter: Boolean = false)

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

    Implicit information
    This member is added by an implicit conversion from DelimiterFraming to ArrowAssoc[DelimiterFraming] 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. def >>[CmdBelowBelow, EvtBelowBelow, BelowContext <: PipelineContext](right: PipelineStage[_ >: BelowContext, ByteString, CmdBelowBelow, ByteString, EvtBelowBelow]): PipelineStage[BelowContext, ByteString, CmdBelowBelow, 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
  9. def apply(ctx: PipelineContext): SymmetricPipePair[ByteString, ByteString] { ... /* 2 definitions in type refinement */ }

    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
    DelimiterFramingPipelineStage
    See also

    AbstractSymmetricPipePair

    AbstractPipePair

    PipelineFactory

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def ensuring(cond: (DelimiterFraming) ⇒ Boolean, msg: ⇒ Any): DelimiterFraming

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

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

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

    Implicit information
    This member is added by an implicit conversion from DelimiterFraming to Ensuring[DelimiterFraming] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from DelimiterFraming to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

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

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

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

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

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

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

    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def |[RightContext <: PipelineContext](right: PipelineStage[_ >: RightContext, ByteString, ByteString, ByteString, ByteString]): PipelineStage[RightContext, ByteString, ByteString, ByteString, 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
  32. def [B](y: B): (DelimiterFraming, B)

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

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

Deprecated Value Members

  1. def x: DelimiterFraming

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

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: DelimiterFraming

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

Inherited by implicit conversion any2stringfmt from DelimiterFraming to StringFormat

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

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

Ungrouped