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 Constants

Annotations
@Generated()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Constants
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 CLIENT_ADDR: String

    Indicates a client address ("ca") in a span.

    Indicates a client address ("ca") in a span. Most likely, there's only one. Multiple addresses are possible when a client changes its ip or port within a span.

  5. val CLIENT_RECV: String

    The client received ("cr") a response from a server.

    The client received ("cr") a response from a server. There is only one receive per span. For example, if duplicate responses were received, each can be logged as a WIRE_RECV annotation.

    If chunking is involved, each chunk could be logged as a separate CLIENT_RECV_FRAGMENT in the same span.

    Annotation.host is not the server. It is the host which logged the receive event, almost always the client. The actual endpoint of the server is recorded separately as SERVER_ADDR when CLIENT_SEND is logged.

  6. val CLIENT_RECV_ERROR: String
  7. val CLIENT_RECV_FRAGMENT: String

    Optionally logs progress of a (CLIENT_RECV, WIRE_RECV).

    Optionally logs progress of a (CLIENT_RECV, WIRE_RECV). For example, this could be one chunk in a chunked response.

  8. val CLIENT_SEND: String

    The client sent ("cs") a request to a server.

    The client sent ("cs") a request to a server. There is only one send per span. For example, if there's a transport error, each attempt can be logged as a WIRE_SEND annotation.

    If chunking is involved, each chunk could be logged as a separate CLIENT_SEND_FRAGMENT in the same span.

    Annotation.host is not the server. It is the host which logged the send event, almost always the client. When logging CLIENT_SEND, instrumentation should also log the SERVER_ADDR.

  9. val CLIENT_SEND_FRAGMENT: String

    Optionally logs progress of a (CLIENT_SEND, WIRE_SEND).

    Optionally logs progress of a (CLIENT_SEND, WIRE_SEND). For example, this could be one chunk in a chunked request.

  10. val SERVER_ADDR: String

    Indicates a server address ("sa") in a span.

    Indicates a server address ("sa") in a span. Most likely, there's only one. Multiple addresses are possible when a client is redirected, or fails to a different server ip or port.

  11. val SERVER_RECV: String

    The server received ("sr") a request from a client.

    The server received ("sr") a request from a client. There is only one request per span. For example, if duplicate responses were received, each can be logged as a WIRE_RECV annotation.

    Typically, a trace starts with a server receive, so the first timestamp of a trace is often the timestamp of the root span's server receive.

    If chunking is involved, each chunk could be logged as a separate SERVER_RECV_FRAGMENT in the same span.

    Annotation.host is not the client. It is the host which logged the receive event, almost always the server. When logging SERVER_RECV, instrumentation should also log the CLIENT_ADDR.

  12. val SERVER_RECV_FRAGMENT: String

    Optionally logs progress of a (SERVER_RECV, WIRE_RECV).

    Optionally logs progress of a (SERVER_RECV, WIRE_RECV). For example, this could be one chunk in a chunked request.

  13. val SERVER_SEND: String

    The server sent ("ss") a response to a client.

    The server sent ("ss") a response to a client. There is only one response per span. If there's a transport error, each attempt can be logged as a WIRE_SEND annotation.

    Typically, a trace ends with a server send, so the last timestamp of a trace is often the timestamp of the root span's server send.

    If chunking is involved, each chunk could be logged as a separate SERVER_SEND_FRAGMENT in the same span.

    Annotation.host is not the client. It is the host which logged the send event, almost always the server. The actual endpoint of the client is recorded separately as CLIENT_ADDR when SERVER_RECV is logged.

  14. val SERVER_SEND_ERROR: String
  15. val SERVER_SEND_FRAGMENT: String

    Optionally logs progress of a (SERVER_SEND, WIRE_SEND).

    Optionally logs progress of a (SERVER_SEND, WIRE_SEND). For example, this could be one chunk in a chunked response.

  16. val WIRE_RECV: String

    Optionally logs an attempt to receive a message from the wire.

    Optionally logs an attempt to receive a message from the wire. Multiple wire receive events could indicate network retries. A lag between wire receive and client or server receive might indicate queuing or processing delay.

  17. val WIRE_RECV_ERROR: String
  18. val WIRE_SEND: String

    Optionally logs an attempt to send a message on the wire.

    Optionally logs an attempt to send a message on the wire. Multiple wire send events could indicate network retries. A lag between client or server send and wire send might indicate queuing or processing delay.

  19. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  20. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  23. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped