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 Endpoint extends TBase[Endpoint, _Fields] with Serializable with Cloneable

Indicates the network context of a service recording an annotation with two exceptions.

When a BinaryAnnotation, and key is CLIENT_ADDR or SERVER_ADDR, the endpoint indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

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

    Performs a deep copy on other.

  2. new Endpoint(ipv4: Int, port: Short, service_name: String)
  3. new Endpoint()

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clear(): Unit
    Definition Classes
    Endpoint → TBase
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def compareTo(other: Endpoint): Int
    Definition Classes
    Endpoint → Comparable
  8. def deepCopy(): Endpoint
    Definition Classes
    Endpoint → TBase
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(that: Endpoint): Boolean
  11. def equals(that: Any): Boolean
    Definition Classes
    Endpoint → AnyRef → Any
  12. def fieldForId(fieldId: Int): _Fields
    Definition Classes
    Endpoint → TBase
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getFieldValue(field: _Fields): AnyRef
    Definition Classes
    Endpoint → TBase
  16. def getIpv4(): Int
  17. def getPort(): Short
  18. def getService_name(): String
  19. def hashCode(): Int
    Definition Classes
    Endpoint → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
    Endpoint → TBase
  22. def isSetIpv4(): Boolean

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

  23. def isSetPort(): Boolean

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

  24. def isSetService_name(): Boolean

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

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def read(iprot: TProtocol): Unit
    Definition Classes
    Endpoint → TBase
  29. def setFieldValue(field: _Fields, value: Any): Unit
    Definition Classes
    Endpoint → TBase
  30. def setIpv4(ipv4: Int): Endpoint
  31. def setIpv4IsSet(value: Boolean): Unit
  32. def setPort(port: Short): Endpoint
  33. def setPortIsSet(value: Boolean): Unit
  34. def setService_name(service_name: String): Endpoint
  35. def setService_nameIsSet(value: Boolean): Unit
  36. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  37. def toString(): String
    Definition Classes
    Endpoint → AnyRef → Any
  38. def unsetIpv4(): Unit
  39. def unsetPort(): Unit
  40. def unsetService_name(): Unit
  41. def validate(): Unit
  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 write(oprot: TProtocol): Unit
    Definition Classes
    Endpoint → TBase

Inherited from Cloneable

Inherited from TBase[Endpoint, _Fields]

Inherited from Serializable

Inherited from Comparable[Endpoint]

Inherited from AnyRef

Inherited from Any

Ungrouped