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
  • Annotation
  • AnnotationType
  • BinaryAnnotation
  • ClientId
  • ConnectionOptions
  • Constants
  • Delegation
  • Endpoint
  • RequestContext
  • RequestHeader
  • ResponseHeader
  • Span
  • UpgradeReply

trait BinaryAnnotation extends ThriftStruct with Product4[String, ByteBuffer, AnnotationType, Option[Endpoint]] with HasThriftStructCodec3[BinaryAnnotation] with Serializable

Prefer the companion object's com.twitter.finagle.thrift.thriftscala.BinaryAnnotation.apply for construction if you don't need to specify passthrough fields.

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

Abstract Value Members

  1. abstract def annotationType: AnnotationType
  2. abstract def 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.

  3. abstract def key: String
  4. abstract def value: ByteBuffer

Concrete 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: ThriftStructCodec3[BinaryAnnotation]
    Definition Classes
    BinaryAnnotation → HasThriftStructCodec3
  9. def _passthroughFields: Map[Short, TFieldBlob]
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def canEqual(other: Any): Boolean
    Definition Classes
    BinaryAnnotation → Equals
  12. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  13. 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
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(other: Any): Boolean
    Definition Classes
    BinaryAnnotation → Equals → AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. 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.

  19. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

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

  20. def hashCode(): Int
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def productArity: Int
    Definition Classes
    BinaryAnnotation → Product4 → Product
  26. def productElement(n: Int): Any
    Definition Classes
    BinaryAnnotation → Product4 → Product
  27. def productIterator: Iterator[Any]
    Definition Classes
    Product
  28. def productPrefix: String
    Definition Classes
    BinaryAnnotation → Product
  29. 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.

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    BinaryAnnotation → AnyRef → Any
  32. def toTuple: (String, ByteBuffer, AnnotationType, Option[Endpoint])
  33. def unsetAnnotationType: BinaryAnnotation
  34. 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.

  35. def unsetHost: BinaryAnnotation
  36. 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.

  37. def unsetValue: BinaryAnnotation
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  41. def write(_oprot: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → ThriftStruct

Inherited from Serializable

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