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

class Span extends TBase[Span, _Fields] with Serializable with Cloneable with Comparable[Span]

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.

Annotations
@SuppressWarnings() @Generated()
Linear Supertypes
Cloneable, TBase[Span, _Fields], Serializable, TSerializable, Comparable[Span], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Span
  2. Cloneable
  3. TBase
  4. Serializable
  5. TSerializable
  6. Comparable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Span(other: Span)

    Performs a deep copy on other.

  2. new Span(trace_id: Long, name: String, id: Long, annotations: List[Annotation], binary_annotations: List[BinaryAnnotation], debug: Boolean)
  3. new Span()

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 addToAnnotations(elem: Annotation): Unit
  5. def addToBinary_annotations(elem: BinaryAnnotation): Unit
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clear(): Unit
    Definition Classes
    Span → TBase
    Annotations
    @Override()
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def compareTo(other: Span): Int
    Definition Classes
    Span → Comparable
    Annotations
    @Override()
  10. def deepCopy(): Span
    Definition Classes
    Span → TBase
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(that: Span): Boolean
  13. def equals(that: AnyRef): Boolean
    Definition Classes
    Span → AnyRef → Any
    Annotations
    @Override()
  14. def fieldForId(fieldId: Int): _Fields
    Definition Classes
    Span → TBase
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def getAnnotations(): List[Annotation]
  17. def getAnnotationsIterator(): Iterator[Annotation]
  18. def getAnnotationsSize(): Int
  19. def getBinary_annotations(): List[BinaryAnnotation]
  20. def getBinary_annotationsIterator(): Iterator[BinaryAnnotation]
  21. def getBinary_annotationsSize(): Int
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def getFieldValue(field: _Fields): AnyRef
    Definition Classes
    Span → TBase
  24. def getId(): Long
  25. def getName(): String
  26. def getParent_id(): Long
  27. def getTimestamp(): Long
  28. def getTrace_id(): Long
  29. def hashCode(): Int
    Definition Classes
    Span → AnyRef → Any
    Annotations
    @Override()
  30. def isDebug(): Boolean
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def isSet(field: _Fields): Boolean

    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

    Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise

    Definition Classes
    Span → TBase
  33. def isSetAnnotations(): Boolean

    Returns true if field annotations is set (has been assigned a value) and false otherwise

  34. def isSetBinary_annotations(): Boolean

    Returns true if field binary_annotations is set (has been assigned a value) and false otherwise

  35. def isSetDebug(): Boolean

    Returns true if field debug is set (has been assigned a value) and false otherwise

  36. def isSetId(): Boolean

    Returns true if field id is set (has been assigned a value) and false otherwise

  37. def isSetName(): Boolean

    Returns true if field name is set (has been assigned a value) and false otherwise

  38. def isSetParent_id(): Boolean

    Returns true if field parent_id is set (has been assigned a value) and false otherwise

  39. def isSetTimestamp(): Boolean

    Returns true if field timestamp is set (has been assigned a value) and false otherwise

  40. def isSetTrace_id(): Boolean

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

  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. def read(iprot: TProtocol): Unit
    Definition Classes
    Span → TSerializable
  45. def setAnnotations(annotations: List[Annotation]): Span
  46. def setAnnotationsIsSet(value: Boolean): Unit
  47. def setBinary_annotations(binary_annotations: List[BinaryAnnotation]): Span
  48. def setBinary_annotationsIsSet(value: Boolean): Unit
  49. def setDebug(debug: Boolean): Span
  50. def setDebugIsSet(value: Boolean): Unit
  51. def setFieldValue(field: _Fields, value: AnyRef): Unit
    Definition Classes
    Span → TBase
  52. def setId(id: Long): Span
  53. def setIdIsSet(value: Boolean): Unit
  54. def setName(name: String): Span
  55. def setNameIsSet(value: Boolean): Unit
  56. def setParent_id(parent_id: Long): Span
  57. def setParent_idIsSet(value: Boolean): Unit
  58. def setTimestamp(timestamp: Long): Span
  59. def setTimestampIsSet(value: Boolean): Unit
  60. def setTrace_id(trace_id: Long): Span
  61. def setTrace_idIsSet(value: Boolean): Unit
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def toString(): String
    Definition Classes
    Span → AnyRef → Any
    Annotations
    @Override()
  64. def unsetAnnotations(): Unit
  65. def unsetBinary_annotations(): Unit
  66. def unsetDebug(): Unit
  67. def unsetId(): Unit
  68. def unsetName(): Unit
  69. def unsetParent_id(): Unit
  70. def unsetTimestamp(): Unit
  71. def unsetTrace_id(): Unit
  72. def validate(): Unit
  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  76. def write(oprot: TProtocol): Unit
    Definition Classes
    Span → TSerializable

Inherited from Cloneable

Inherited from TBase[Span, _Fields]

Inherited from Serializable

Inherited from TSerializable

Inherited from Comparable[Span]

Inherited from AnyRef

Inherited from Any

Ungrouped