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

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

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

Linear Supertypes
Cloneable, TBase[RequestHeader, _Fields], Serializable, Comparable[RequestHeader], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RequestHeader
  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 RequestHeader(other: RequestHeader)

    Performs a deep copy on other.

  2. new RequestHeader(trace_id: Long, span_id: Long, contexts: List[RequestContext])
  3. new RequestHeader()

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 addToContexts(elem: RequestContext): Unit
  5. def addToDelegations(elem: Delegation): Unit
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clear(): Unit
    Definition Classes
    RequestHeader → TBase
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def compareTo(other: RequestHeader): Int
    Definition Classes
    RequestHeader → Comparable
  10. def deepCopy(): RequestHeader
    Definition Classes
    RequestHeader → TBase
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(that: RequestHeader): Boolean
  13. def equals(that: Any): Boolean
    Definition Classes
    RequestHeader → AnyRef → Any
  14. def fieldForId(fieldId: Int): _Fields
    Definition Classes
    RequestHeader → TBase
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getClient_id(): ClientId
  18. def getContexts(): List[RequestContext]
  19. def getContextsIterator(): Iterator[RequestContext]
  20. def getContextsSize(): Int
  21. def getDelegations(): List[Delegation]
  22. def getDelegationsIterator(): Iterator[Delegation]
  23. def getDelegationsSize(): Int
  24. def getDest(): String
  25. def getFieldValue(field: _Fields): AnyRef
    Definition Classes
    RequestHeader → TBase
  26. def getFlags(): Long
  27. def getParent_span_id(): Long
  28. def getSpan_id(): Long
  29. def getTrace_id(): Long
  30. def getTrace_id_high(): Long
  31. def hashCode(): Int
    Definition Classes
    RequestHeader → AnyRef → Any
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isSampled(): Boolean
  34. 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
    RequestHeader → TBase
  35. def isSetClient_id(): Boolean

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

  36. def isSetContexts(): Boolean

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

  37. def isSetDelegations(): Boolean

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

  38. def isSetDest(): Boolean

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

  39. def isSetFlags(): Boolean

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

  40. def isSetParent_span_id(): Boolean

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

  41. def isSetSampled(): Boolean

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

  42. def isSetSpan_id(): Boolean

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

  43. def isSetTrace_id(): Boolean

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

  44. def isSetTrace_id_high(): Boolean

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

  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. def read(iprot: TProtocol): Unit
    Definition Classes
    RequestHeader → TBase
  49. def setClient_id(client_id: ClientId): RequestHeader
  50. def setClient_idIsSet(value: Boolean): Unit
  51. def setContexts(contexts: List[RequestContext]): RequestHeader
  52. def setContextsIsSet(value: Boolean): Unit
  53. def setDelegations(delegations: List[Delegation]): RequestHeader
  54. def setDelegationsIsSet(value: Boolean): Unit
  55. def setDest(dest: String): RequestHeader
  56. def setDestIsSet(value: Boolean): Unit
  57. def setFieldValue(field: _Fields, value: Any): Unit
    Definition Classes
    RequestHeader → TBase
  58. def setFlags(flags: Long): RequestHeader
  59. def setFlagsIsSet(value: Boolean): Unit
  60. def setParent_span_id(parent_span_id: Long): RequestHeader
  61. def setParent_span_idIsSet(value: Boolean): Unit
  62. def setSampled(sampled: Boolean): RequestHeader
  63. def setSampledIsSet(value: Boolean): Unit
  64. def setSpan_id(span_id: Long): RequestHeader
  65. def setSpan_idIsSet(value: Boolean): Unit
  66. def setTrace_id(trace_id: Long): RequestHeader
  67. def setTrace_idIsSet(value: Boolean): Unit
  68. def setTrace_id_high(trace_id_high: Long): RequestHeader
  69. def setTrace_id_highIsSet(value: Boolean): Unit
  70. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  71. def toString(): String
    Definition Classes
    RequestHeader → AnyRef → Any
  72. def unsetClient_id(): Unit
  73. def unsetContexts(): Unit
  74. def unsetDelegations(): Unit
  75. def unsetDest(): Unit
  76. def unsetFlags(): Unit
  77. def unsetParent_span_id(): Unit
  78. def unsetSampled(): Unit
  79. def unsetSpan_id(): Unit
  80. def unsetTrace_id(): Unit
  81. def unsetTrace_id_high(): Unit
  82. def validate(): Unit
  83. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  86. def write(oprot: TProtocol): Unit
    Definition Classes
    RequestHeader → TBase

Inherited from Cloneable

Inherited from TBase[RequestHeader, _Fields]

Inherited from Serializable

Inherited from Comparable[RequestHeader]

Inherited from AnyRef

Inherited from Any

Ungrouped