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 RequestHeader extends ThriftStructCodec3[RequestHeader] with Serializable

RequestHeader defines headers for the request. These carry the span data, and a flag indicating whether the request is to be debugged.

Linear Supertypes
Serializable, Serializable, ThriftStructCodec3[RequestHeader], ThriftStructCodec[RequestHeader], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestHeader
  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 RequestHeader

    The default read-only implementation of RequestHeader.

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

  2. trait Proxy extends RequestHeader

    This Proxy trait allows you to extend the RequestHeader trait with additional state or behavior and implement the read-only methods from RequestHeader 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 ClientIdField: TField
  5. val ClientIdFieldManifest: Manifest[ClientId]
  6. val ContextsField: TField
  7. val ContextsFieldManifest: Manifest[Seq[RequestContext]]
  8. val DelegationsField: TField
  9. val DelegationsFieldManifest: Manifest[Seq[Delegation]]
  10. val DestField: TField
  11. val DestFieldManifest: Manifest[String]
  12. val FlagsField: TField
  13. val FlagsFieldManifest: Manifest[Long]
  14. val NoPassthroughFields: Map[Short, TFieldBlob]
  15. val ParentSpanIdField: TField
  16. val ParentSpanIdFieldManifest: Manifest[Long]
  17. val SampledField: TField
  18. val SampledFieldManifest: Manifest[Boolean]
  19. val SpanIdField: TField
  20. val SpanIdFieldManifest: Manifest[Long]
  21. val Struct: TStruct
  22. val TraceIdField: TField
  23. val TraceIdFieldManifest: Manifest[Long]
  24. val TraceIdHighField: TField
  25. val TraceIdHighFieldManifest: Manifest[Long]
  26. def apply(traceId: Long, spanId: Long, parentSpanId: Option[Long] = _root_.scala.None, sampled: Option[Boolean] = _root_.scala.None, clientId: Option[ClientId] = _root_.scala.None, flags: Option[Long] = _root_.scala.None, contexts: Seq[RequestContext] = ..., dest: Option[String] = _root_.scala.None, delegations: Option[Seq[Delegation]] = _root_.scala.None, traceIdHigh: Option[Long] = _root_.scala.None): RequestHeader
  27. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  28. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  29. def decode(_iprot: TProtocol): RequestHeader
    Definition Classes
    RequestHeader → ThriftStructCodec
  30. def encode(_item: RequestHeader, _oproto: TProtocol): Unit
    Definition Classes
    RequestHeader → ThriftStructCodec
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  33. lazy val fieldInfos: List[ThriftStructFieldInfo]

    Field information in declaration order.

  34. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. lazy val metaData: ThriftStructMetaData[RequestHeader]
    Definition Classes
    ThriftStructCodec
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. lazy val structAnnotations: Map[String, String]
  43. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. def ttypeToString(byte: Byte): String
    Attributes
    protected
    Definition Classes
    ThriftStructCodec3
  46. def unapply(_item: RequestHeader): Option[(Long, Long, Option[Long], Option[Boolean], Option[ClientId], Option[Long], Seq[RequestContext], Option[String], Option[Seq[Delegation]], Option[Long])]
  47. def validate(_item: RequestHeader): Unit

    Checks that all required fields are non-null.

  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  51. def withoutPassthroughFields(original: RequestHeader): RequestHeader
  52. object Immutable extends ThriftStructCodec3[RequestHeader] with Serializable

Inherited from Serializable

Inherited from Serializable

Inherited from ThriftStructCodec3[RequestHeader]

Inherited from ThriftStructCodec[RequestHeader]

Inherited from AnyRef

Inherited from Any

Ungrouped