Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    Definition Classes
    com
  • package finagle

    Finagle is an extensible RPC system.

    Finagle is an extensible RPC system.

    Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

    Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

    Thus a simple HTTP server is built like this:

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Await, Future}
    
    val service = new Service[Request, Response] {
      def apply(req: Request): Future[Response] =
        Future.value(Response())
    }
    val server = Http.server.serve(":8080", service)
    Await.ready(server)

    We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

    This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

    We can now query our web server:

    % curl -D - localhost:8080
    HTTP/1.1 200 OK

    Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Future, Return, Throw}
    
    val client: Service[Request, Response] = Http.client.newService("localhost:8080")
    val f: Future[Response] = client(Request()).respond {
      case Return(rep) =>
        printf("Got HTTP response %s\n", rep)
      case Throw(exc) =>
        printf("Got error %s\n", exc)
    }

    Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

    The Finagle homepage contains useful documentation and resources for using Finagle.

    Definition Classes
    twitter
  • package thrift

    Please use the new interface, com.twitter.finagle.Thrift, for constructing Thrift clients and servers.

    Deprecation

    Please use the new interface, com.twitter.finagle.Thrift, for constructing Thrift clients and servers.

    Thrift codecs

    We provide client and server protocol support for the framed protocol. The public implementations are defined on the Thrift object:

    The type of the server codec is Service[Array[Byte], Array[Byte]] and the client codecs are Service[ThriftClientRequest, Array[Byte]]. The service provided is that of a "transport" of thrift messages (requests and replies) according to the protocol chosen. This is why the client codecs need to have access to a thrift ProtocolFactory.

    These transports are used by the services produced by the finagle thrift codegenerator.

    val service: Service[ThriftClientRequest, Array[Byte]] = ClientBuilder()
      .hosts("foobar.com:123")
      .stack(Thrift.client)
      .build()
    
    // Wrap the raw Thrift transport in a Client decorator. The client
    // provides a convenient procedural interface for accessing the Thrift
    // server.
    val client = new Hello.ServiceToClient(service, protocolFactory)

    In this example, Hello is the thrift interface, and the inner class ServiceToClient is provided by the finagle thrift code generator.

    Definition Classes
    finagle
  • package thrift
    Definition Classes
    thrift
  • Annotation
  • AnnotationType
  • BinaryAnnotation
  • ClientId
  • ConnectionOptions
  • Constants
  • Delegation
  • Endpoint
  • RequestContext
  • RequestHeader
  • ResponseHeader
  • Span
  • UpgradeReply
c

com.twitter.finagle.thrift.thrift

BinaryAnnotation

class BinaryAnnotation extends TBase[BinaryAnnotation, _Fields] with Serializable with Cloneable

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

Binary annotations of type STRING are always queryable, though more of 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
Cloneable, TBase[BinaryAnnotation, _Fields], Serializable, Comparable[BinaryAnnotation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinaryAnnotation
  2. Cloneable
  3. TBase
  4. Serializable
  5. Comparable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BinaryAnnotation(other: BinaryAnnotation)

    Performs a deep copy on other.

  2. new BinaryAnnotation(key: String, value: ByteBuffer, annotation_type: AnnotationType)
  3. new BinaryAnnotation()

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 BufferForValue(): ByteBuffer
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clear(): Unit
    Definition Classes
    BinaryAnnotation → TBase
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def compareTo(other: BinaryAnnotation): Int
    Definition Classes
    BinaryAnnotation → Comparable
  9. def deepCopy(): BinaryAnnotation
    Definition Classes
    BinaryAnnotation → TBase
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(that: BinaryAnnotation): Boolean
  12. def equals(that: Any): Boolean
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  13. def fieldForId(fieldId: Int): _Fields
    Definition Classes
    BinaryAnnotation → TBase
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def getAnnotation_type(): AnnotationType

    See also

    AnnotationType

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getFieldValue(field: _Fields): AnyRef
    Definition Classes
    BinaryAnnotation → TBase
  18. def getHost(): Endpoint

    The host that recorded tag, which allows you to differentiate between multiple tags with the same key.

    The host that recorded tag, which allows you to differentiate between multiple tags with the same key. There are two exceptions to this.

    When the key is CLIENT_ADDR or SERVER_ADDR, host indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

  19. def getKey(): String
  20. def getValue(): Array[Byte]
  21. def hashCode(): Int
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isSet(field: _Fields): Boolean

    Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise

    Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise

    Definition Classes
    BinaryAnnotation → TBase
  24. def isSetAnnotation_type(): Boolean

    Returns true if field annotation_type is set (has been asigned a value) and false otherwise

  25. def isSetHost(): Boolean

    Returns true if field host is set (has been asigned a value) and false otherwise

  26. def isSetKey(): Boolean

    Returns true if field key is set (has been asigned a value) and false otherwise

  27. def isSetValue(): Boolean

    Returns true if field value is set (has been asigned a value) and false otherwise

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def read(iprot: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → TBase
  32. def setAnnotation_type(annotation_type: AnnotationType): BinaryAnnotation

    See also

    AnnotationType

  33. def setAnnotation_typeIsSet(value: Boolean): Unit
  34. def setFieldValue(field: _Fields, value: Any): Unit
    Definition Classes
    BinaryAnnotation → TBase
  35. def setHost(host: Endpoint): BinaryAnnotation

    The host that recorded tag, which allows you to differentiate between multiple tags with the same key.

    The host that recorded tag, which allows you to differentiate between multiple tags with the same key. There are two exceptions to this.

    When the key is CLIENT_ADDR or SERVER_ADDR, host indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

  36. def setHostIsSet(value: Boolean): Unit
  37. def setKey(key: String): BinaryAnnotation
  38. def setKeyIsSet(value: Boolean): Unit
  39. def setValue(value: ByteBuffer): BinaryAnnotation
  40. def setValue(value: Array[Byte]): BinaryAnnotation
  41. def setValueIsSet(value: Boolean): Unit
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  44. def unsetAnnotation_type(): Unit
  45. def unsetHost(): Unit
  46. def unsetKey(): Unit
  47. def unsetValue(): Unit
  48. def validate(): Unit
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  52. def write(oprot: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → TBase

Inherited from Cloneable

Inherited from TBase[BinaryAnnotation, _Fields]

Inherited from Serializable

Inherited from Comparable[BinaryAnnotation]

Inherited from AnyRef

Inherited from Any

Ungrouped