Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

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

    RequestHeader defines headers for the request.

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

    Definition Classes
    thriftscala
  • Immutable

class Immutable extends 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.

Linear Supertypes
RequestHeader, Serializable, ValidatingThriftStruct[RequestHeader], HasThriftStructCodec3[RequestHeader], Product10[Long, Long, Option[Long], Option[Boolean], Option[ClientId], Option[Long], Seq[RequestContext], Option[String], Option[Seq[Delegation]], Option[Long]], Product, Equals, ThriftStruct, ThriftStructIface, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Immutable
  2. RequestHeader
  3. Serializable
  4. ValidatingThriftStruct
  5. HasThriftStructCodec3
  6. Product10
  7. Product
  8. Equals
  9. ThriftStruct
  10. ThriftStructIface
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Immutable(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] = _root_.scala.collection.immutable.Nil, dest: Option[String] = _root_.scala.None, delegations: Option[Seq[Delegation]] = _root_.scala.None, traceIdHigh: Option[Long] = _root_.scala.None)
  2. new Immutable(traceId: Long, spanId: Long, parentSpanId: Option[Long], sampled: Option[Boolean], clientId: Option[ClientId], flags: Option[Long], contexts: Seq[RequestContext], dest: Option[String], delegations: Option[Seq[Delegation]], traceIdHigh: Option[Long], _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: Long
    Definition Classes
    RequestHeader → Product10
  5. def _10: Option[Long]
    Definition Classes
    RequestHeader → Product10
  6. def _2: Long
    Definition Classes
    RequestHeader → Product10
  7. def _3: Option[Long]
    Definition Classes
    RequestHeader → Product10
  8. def _4: Option[Boolean]
    Definition Classes
    RequestHeader → Product10
  9. def _5: Option[ClientId]
    Definition Classes
    RequestHeader → Product10
  10. def _6: Option[Long]
    Definition Classes
    RequestHeader → Product10
  11. def _7: Seq[RequestContext]
    Definition Classes
    RequestHeader → Product10
  12. def _8: Option[String]
    Definition Classes
    RequestHeader → Product10
  13. def _9: Option[Seq[Delegation]]
    Definition Classes
    RequestHeader → Product10
  14. def _codec: ValidatingThriftStructCodec3[RequestHeader]
    Definition Classes
    RequestHeader → ValidatingThriftStruct → HasThriftStructCodec3
  15. val _passthroughFields: Map[Short, TFieldBlob]
    Definition Classes
    Immutable → RequestHeader
  16. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  17. def canEqual(other: Any): Boolean
    Definition Classes
    RequestHeader → Equals
  18. val clientId: Option[ClientId]
    Definition Classes
    Immutable → RequestHeader
  19. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  20. val contexts: Seq[RequestContext]
    Definition Classes
    Immutable → RequestHeader
  21. def copy(traceId: Long = this.traceId, spanId: Long = this.spanId, parentSpanId: Option[Long] = this.parentSpanId, sampled: Option[Boolean] = this.sampled, clientId: Option[ClientId] = this.clientId, flags: Option[Long] = this.flags, contexts: Seq[RequestContext] = this.contexts, dest: Option[String] = this.dest, delegations: Option[Seq[Delegation]] = this.delegations, traceIdHigh: Option[Long] = this.traceIdHigh, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): RequestHeader
    Definition Classes
    RequestHeader
  22. val delegations: Option[Seq[Delegation]]
    Definition Classes
    Immutable → RequestHeader
  23. val dest: Option[String]
    Definition Classes
    Immutable → RequestHeader
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(other: Any): Boolean
    Definition Classes
    RequestHeader → Equals → AnyRef → Any
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  27. val flags: Option[Long]
    Definition Classes
    Immutable → RequestHeader
  28. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  29. 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
    RequestHeader
  30. 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
    RequestHeader
  31. def hashCode(): Int
    Definition Classes
    RequestHeader → AnyRef → Any
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. def newBuilder(): StructBuilder[RequestHeader]
    Definition Classes
    RequestHeader
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. val parentSpanId: Option[Long]
    Definition Classes
    Immutable → RequestHeader
  38. def productArity: Int
    Definition Classes
    Product10 → Product
  39. def productElement(n: Int): Any
    Definition Classes
    Product10 → Product
    Annotations
    @throws(classOf[java.lang.IndexOutOfBoundsException])
  40. def productElementName(n: Int): String
    Definition Classes
    Product
  41. def productElementNames: Iterator[String]
    Definition Classes
    Product
  42. def productIterator: Iterator[Any]
    Definition Classes
    Product
  43. def productPrefix: String
    Definition Classes
    RequestHeader → Product
  44. val sampled: Option[Boolean]
    Definition Classes
    Immutable → RequestHeader
  45. def setField(_blob: TFieldBlob): RequestHeader

    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
    RequestHeader
  46. val spanId: Long
    Definition Classes
    Immutable → RequestHeader
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toString(): String
    Definition Classes
    RequestHeader → AnyRef → Any
  49. def toTuple: (Long, Long, Option[Long], Option[Boolean], Option[ClientId], Option[Long], Seq[RequestContext], Option[String], Option[Seq[Delegation]], Option[Long])
    Definition Classes
    RequestHeader
  50. val traceId: Long
    Definition Classes
    Immutable → RequestHeader
  51. val traceIdHigh: Option[Long]
    Definition Classes
    Immutable → RequestHeader
  52. def unsetClientId: RequestHeader
    Definition Classes
    RequestHeader
  53. def unsetContexts: RequestHeader
    Definition Classes
    RequestHeader
  54. def unsetDelegations: RequestHeader
    Definition Classes
    RequestHeader
  55. def unsetDest: RequestHeader
    Definition Classes
    RequestHeader
  56. def unsetField(_fieldId: Short): RequestHeader

    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
    RequestHeader
  57. def unsetFlags: RequestHeader
    Definition Classes
    RequestHeader
  58. def unsetParentSpanId: RequestHeader
    Definition Classes
    RequestHeader
  59. def unsetSampled: RequestHeader
    Definition Classes
    RequestHeader
  60. def unsetSpanId: RequestHeader
    Definition Classes
    RequestHeader
  61. def unsetTraceId: RequestHeader

    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
    RequestHeader
  62. def unsetTraceIdHigh: RequestHeader
    Definition Classes
    RequestHeader
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  66. def write(_oprot: TProtocol): Unit
    Definition Classes
    RequestHeader → ThriftStruct

Inherited from RequestHeader

Inherited from Serializable

Inherited from ValidatingThriftStruct[RequestHeader]

Inherited from HasThriftStructCodec3[RequestHeader]

Inherited from Product10[Long, Long, Option[Long], Option[Boolean], Option[ClientId], Option[Long], Seq[RequestContext], Option[String], Option[Seq[Delegation]], Option[Long]]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from ThriftStructIface

Inherited from AnyRef

Inherited from Any

Ungrouped