com.twitter.finagle.thrift.thriftscala

BinaryAnnotation

object BinaryAnnotation extends ThriftStructCodec3[BinaryAnnotation] with Serializable

Binary annotations are tags applied to a Span to give it context. For example, a binary annotation of "http.uri" could the path to a resource in a RPC call.

Binary annotations of type STRING are always queryable, though more a historical implementation detail than a structural concern.

Binary annotations can repeat, and vary on the host. Similar to Annotation, the host indicates who logged the event. This allows you to tell the difference between the client and server side of the same key. For example, the key "http.uri" might be different on the client and server side due to rewriting, like "/api/v1/myresource" vs "/myresource. Via the host field, you can see the different points of view, which often help in debugging.

Linear Supertypes
Serializable, Serializable, ThriftStructCodec3[BinaryAnnotation], ThriftStructCodec[BinaryAnnotation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. BinaryAnnotation
  2. Serializable
  3. Serializable
  4. ThriftStructCodec3
  5. ThriftStructCodec
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class Immutable extends BinaryAnnotation

    The default read-only implementation of BinaryAnnotation.

  2. trait Proxy extends BinaryAnnotation

    This Proxy trait allows you to extend the BinaryAnnotation trait with additional state or behavior and implement the read-only methods from BinaryAnnotation using an underlying instance.

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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. val AnnotationTypeField: TField

  7. val AnnotationTypeFieldI32: TField

  8. val AnnotationTypeFieldManifest: Manifest[AnnotationType]

  9. val HostField: TField

  10. val HostFieldManifest: Manifest[Endpoint]

  11. object Immutable extends ThriftStructCodec3[BinaryAnnotation] with Serializable

  12. val KeyField: TField

  13. val KeyFieldManifest: Manifest[String]

  14. val Struct: TStruct

  15. val ValueField: TField

  16. val ValueFieldManifest: Manifest[ByteBuffer]

  17. def apply(key: String, value: ByteBuffer, annotationType: AnnotationType, host: Option[Endpoint] = _root_.scala.None): BinaryAnnotation

  18. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  19. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def decode(_iprot: TProtocol): BinaryAnnotation

    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  21. val decoder: (TProtocol) ⇒ BinaryAnnotation

    Definition Classes
    ThriftStructCodec3 → ThriftStructCodec
  22. def encode(_item: BinaryAnnotation, _oproto: TProtocol): Unit

    Definition Classes
    BinaryAnnotation → ThriftStructCodec
  23. val encoder: (BinaryAnnotation, TProtocol) ⇒ Unit

    Definition Classes
    ThriftStructCodec3 → ThriftStructCodec
  24. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  26. lazy val fieldInfos: List[ThriftStructFieldInfo]

    Field information in declaration order.

  27. def finalize(): Unit

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

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

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

    Definition Classes
    Any
  31. lazy val metaData: ThriftStructMetaData[BinaryAnnotation]

    Definition Classes
    ThriftStructCodec
  32. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  35. lazy val structAnnotations: Map[String, String]

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

    Definition Classes
    AnyRef
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. def ttypeToString(byte: Byte): String

    Attributes
    protected
    Definition Classes
    ThriftStructCodec3
  39. def unapply(_item: BinaryAnnotation): Option[Product4[String, ByteBuffer, AnnotationType, Option[Endpoint]]]

  40. def validate(_item: BinaryAnnotation): Unit

    Checks that all required fields are non-null.

  41. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. def withoutPassthroughFields(original: BinaryAnnotation): BinaryAnnotation

Inherited from Serializable

Inherited from Serializable

Inherited from ThriftStructCodec3[BinaryAnnotation]

Inherited from ThriftStructCodec[BinaryAnnotation]

Inherited from AnyRef

Inherited from Any

Ungrouped