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 thriftscala
    Definition Classes
    thrift
  • object BinaryAnnotation extends ValidatingThriftStructCodec3[BinaryAnnotation] with Serializable

    Binary annotations are tags applied to a Span to give it context.

    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.

    Definition Classes
    thriftscala
  • Immutable
  • Proxy

class Immutable extends BinaryAnnotation

The default read-only implementation of BinaryAnnotation. You typically should not need to directly reference this class; instead, use the BinaryAnnotation.apply method to construct new instances.

Linear Supertypes
BinaryAnnotation, Serializable, ValidatingThriftStruct[BinaryAnnotation], HasThriftStructCodec3[BinaryAnnotation], Product4[String, ByteBuffer, AnnotationType, Option[Endpoint]], Product, Equals, ThriftStruct, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Immutable
  2. BinaryAnnotation
  3. Serializable
  4. ValidatingThriftStruct
  5. HasThriftStructCodec3
  6. Product4
  7. Product
  8. Equals
  9. ThriftStruct
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Immutable(key: String, value: ByteBuffer, annotationType: AnnotationType, host: Option[Endpoint] = _root_.scala.None)
  2. new Immutable(key: String, value: ByteBuffer, annotationType: AnnotationType, host: Option[Endpoint], _passthroughFields: Map[Short, TFieldBlob])

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 _1: String
    Definition Classes
    BinaryAnnotation → Product4
  5. def _2: ByteBuffer
    Definition Classes
    BinaryAnnotation → Product4
  6. def _3: AnnotationType
    Definition Classes
    BinaryAnnotation → Product4
  7. def _4: Option[Endpoint]
    Definition Classes
    BinaryAnnotation → Product4
  8. def _codec: ValidatingThriftStructCodec3[BinaryAnnotation]
    Definition Classes
    BinaryAnnotation → ValidatingThriftStruct → HasThriftStructCodec3
  9. val _passthroughFields: Map[Short, TFieldBlob]
    Definition Classes
    ImmutableBinaryAnnotation
  10. val annotationType: AnnotationType
    Definition Classes
    ImmutableBinaryAnnotation
  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def canEqual(other: Any): Boolean
    Definition Classes
    BinaryAnnotation → Equals
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  14. def copy(key: String = this.key, value: ByteBuffer = this.value, annotationType: AnnotationType = this.annotationType, host: Option[Endpoint] = this.host, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): BinaryAnnotation
    Definition Classes
    BinaryAnnotation
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(other: Any): Boolean
    Definition Classes
    BinaryAnnotation → Equals → AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getFieldBlob(_fieldId: Short): Option[TFieldBlob]

    Gets a field value encoded as a binary blob using TCompactProtocol.

    Gets a field value encoded as a binary blob using TCompactProtocol. If the specified field is present in the passthrough map, that value is returned. Otherwise, if the specified field is known and not optional and set to None, then the field is serialized and returned.

    Definition Classes
    BinaryAnnotation
  20. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

    Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.

    Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.

    Definition Classes
    BinaryAnnotation
  21. def hashCode(): Int
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  22. val host: Option[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.

    Definition Classes
    ImmutableBinaryAnnotation
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val key: String
    Definition Classes
    ImmutableBinaryAnnotation
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def productArity: Int
    Definition Classes
    BinaryAnnotation → Product4 → Product
  29. def productElement(n: Int): Any
    Definition Classes
    BinaryAnnotation → Product4 → Product
  30. def productIterator: Iterator[Any]
    Definition Classes
    Product
  31. def productPrefix: String
    Definition Classes
    BinaryAnnotation → Product
  32. def setField(_blob: TFieldBlob): BinaryAnnotation

    Sets a field using a TCompactProtocol-encoded binary blob.

    Sets a field using a TCompactProtocol-encoded binary blob. If the field is a known field, the blob is decoded and the field is set to the decoded value. If the field is unknown and passthrough fields are enabled, then the blob will be stored in _passthroughFields.

    Definition Classes
    BinaryAnnotation
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toString(): String
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  35. def toTuple: (String, ByteBuffer, AnnotationType, Option[Endpoint])
    Definition Classes
    BinaryAnnotation
  36. def unsetAnnotationType: BinaryAnnotation
    Definition Classes
    BinaryAnnotation
  37. def unsetField(_fieldId: Short): BinaryAnnotation

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

    Definition Classes
    BinaryAnnotation
  38. def unsetHost: BinaryAnnotation
    Definition Classes
    BinaryAnnotation
  39. def unsetKey: BinaryAnnotation

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

    Definition Classes
    BinaryAnnotation
  40. def unsetValue: BinaryAnnotation
    Definition Classes
    BinaryAnnotation
  41. val value: ByteBuffer
    Definition Classes
    ImmutableBinaryAnnotation
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  45. def write(_oprot: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → ThriftStruct

Inherited from BinaryAnnotation

Inherited from Serializable

Inherited from ValidatingThriftStruct[BinaryAnnotation]

Inherited from HasThriftStructCodec3[BinaryAnnotation]

Inherited from Product4[String, ByteBuffer, AnnotationType, Option[Endpoint]]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from AnyRef

Inherited from Any

Ungrouped