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 tracing
    Definition Classes
    finagle
  • package opencensus
    Definition Classes
    tracing
  • object StackClientOps

    Syntax enhancements to Finagle clients to add OpenCensus tracing headers to requests.

    Syntax enhancements to Finagle clients to add OpenCensus tracing headers to requests.

    HTTP and ThriftMux protocols are supported.

    Servers should also participate by using StackServerOps.

    Definition Classes
    opencensus
    Example:
    1. Scala:

      import com.twitter.finagle.Http
      import com.twitter.finagle.tracing.opencensus.StackClientOps._
      
      val clientWithOpenCensusTracing = Http.client.withOpenCensusTracing

      Java users can explicitly use a StackClientOps class:

      import com.twitter.finagle.Http;
      import com.twitter.finagle.tracing.opencensus.StackClientOps.HttpOpenCensusTracing;
      
      Http.Client clientWithOpenCensusTracing =
        new HttpOpenCensusTracing(Http.client()).withOpenCensusTracing();
    See also

    StackServerOps

  • HttpOpenCensusTracing
  • ThriftMuxOpenCensusTracing

implicit final class HttpOpenCensusTracing extends AnyVal

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpOpenCensusTracing
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HttpOpenCensusTracing(client: Http.Client)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  6. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  7. def toString(): String
    Definition Classes
    Any
  8. def withOpenCensusTracing(textFormat: TextFormat): Http.Client
  9. def withOpenCensusTracing: Http.Client

Inherited from AnyVal

Inherited from Any

Ungrouped