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

object Span extends ThriftStructCodec3[Span] with Serializable

A trace is a series of spans (often RPC calls) which form a latency tree.

The root span is where trace_id = id and parent_id = Nil. The root span is usually the longest interval in the trace, starting with a SERVER_RECV annotation and ending with a SERVER_SEND.

Linear Supertypes
Serializable, Serializable, ThriftStructCodec3[Span], ThriftStructCodec[Span], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Span
  2. Serializable
  3. Serializable
  4. ThriftStructCodec3
  5. ThriftStructCodec
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class Immutable extends Span

    The default read-only implementation of Span.

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

  2. trait Proxy extends Span

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

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. val AnnotationsField: TField
  5. val AnnotationsFieldManifest: Manifest[Seq[Annotation]]
  6. val BinaryAnnotationsField: TField
  7. val BinaryAnnotationsFieldManifest: Manifest[Seq[BinaryAnnotation]]
  8. val DebugField: TField
  9. val DebugFieldManifest: Manifest[Boolean]
  10. val IdField: TField
  11. val IdFieldManifest: Manifest[Long]
  12. val NameField: TField
  13. val NameFieldManifest: Manifest[String]
  14. val NoPassthroughFields: Map[Short, TFieldBlob]
  15. val ParentIdField: TField
  16. val ParentIdFieldManifest: Manifest[Long]
  17. val Struct: TStruct
  18. val TraceIdField: TField
  19. val TraceIdFieldManifest: Manifest[Long]
  20. def apply(traceId: Long, name: String, id: Long, parentId: Option[Long] = _root_.scala.None, annotations: Seq[Annotation] = ..., binaryAnnotations: Seq[BinaryAnnotation] = ..., debug: Boolean): Span
  21. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  22. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  23. def decode(_iprot: TProtocol): Span
    Definition Classes
    Span → ThriftStructCodec
  24. def encode(_item: Span, _oproto: TProtocol): Unit
    Definition Classes
    Span → ThriftStructCodec
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  27. lazy val fieldInfos: List[ThriftStructFieldInfo]

    Field information in declaration order.

  28. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. lazy val metaData: ThriftStructMetaData[Span]
    Definition Classes
    ThriftStructCodec
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. lazy val structAnnotations: Map[String, String]
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. def ttypeToString(byte: Byte): String
    Attributes
    protected
    Definition Classes
    ThriftStructCodec3
  40. def unapply(_item: Span): Option[(Long, String, Long, Option[Long], Seq[Annotation], Seq[BinaryAnnotation], Boolean)]
  41. def validate(_item: Span): Unit

    Checks that all required fields are non-null.

  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 withoutPassthroughFields(original: Span): Span
  46. object Immutable extends ThriftStructCodec3[Span] with Serializable

Inherited from Serializable

Inherited from Serializable

Inherited from ThriftStructCodec3[Span]

Inherited from ThriftStructCodec[Span]

Inherited from AnyRef

Inherited from Any

Ungrouped