Trait

com.ccadllc.cedi.dtrace

HeaderCodec

Related Doc: package dtrace

Permalink

trait HeaderCodec extends AnyRef

Describes functionality for encoding or decoding a SpanId to one or more headers. Protocol specific modules implement this and those implementations can be composed in order to support headers from multiple protocols in the priority order desired by the composer.

Self Type
HeaderCodec
Source
HeaderCodec.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HeaderCodec
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(headers: List[Header], properties: Map[String, String]): Either[DecodeFailure, Decoded]

    Permalink

    Decode a SpanId and sampled flag from protocol-specific Headers.

    Decode a SpanId and sampled flag from protocol-specific Headers. Protocol-specific name/value properties can be passed in the given map.

  2. abstract def encode(spanId: SpanId, properties: Map[String, String]): List[Header]

    Permalink

    Encode an Header given a SpanId.

    Encode an Header given a SpanId. Protocol-specific name/value properties can be passed in the given map to configure behavior for that protocol. For example, the xb3 module allows one to pass Map("Compressed", "true") to generate a compressed 'b3' header which combines the trace ID, span ID and parent XB3 header values into one and Map("Sampling", "false") to set the X-B3-Sampled to "0".

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from HeaderCodec to any2stringadd[HeaderCodec] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HeaderCodec, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from HeaderCodec to ArrowAssoc[HeaderCodec] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def andThen(other: HeaderCodec): HeaderCodec

    Permalink

    Convenience methods to compose multiple HeaderCodecs when parsing and encoding headers for multiple protocols (e.g., money and xb3).

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  9. def compose(other: HeaderCodec): HeaderCodec

    Permalink
  10. def decode(headers: List[Header]): Either[DecodeFailure, Decoded]

    Permalink

    Decode a SpanId and sampled flag from protocol-specific Headers.

    Decode a SpanId and sampled flag from protocol-specific Headers. A convenience variant of decode(headers, properties) when no properties apply to the decoding.

  11. def encode(spanId: SpanId): List[Header]

    Permalink

    Encode an Header given a SpanId.

    Encode an Header given a SpanId. A convenience variant of encode(spanId, properties) when no properties apply to the encoding.

  12. def ensuring(cond: (HeaderCodec) ⇒ Boolean, msg: ⇒ Any): HeaderCodec

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def formatted(fmtstr: String): String

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (HeaderCodec, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from HeaderCodec to ArrowAssoc[HeaderCodec] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from HeaderCodec to any2stringadd[HeaderCodec]

Inherited by implicit conversion StringFormat from HeaderCodec to StringFormat[HeaderCodec]

Inherited by implicit conversion Ensuring from HeaderCodec to Ensuring[HeaderCodec]

Inherited by implicit conversion ArrowAssoc from HeaderCodec to ArrowAssoc[HeaderCodec]

Ungrouped