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 zipkin
    Definition Classes
    finagle
  • package core
    Definition Classes
    zipkin
  • package thrift
    Definition Classes
    zipkin
  • package thriftscala
    Definition Classes
    zipkin
  • LogEntry
  • ResultCode
  • Scribe
  • Scribe$FinagleClient
  • Scribe$FinagleService

package thriftscala

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. trait LogEntry extends ThriftStruct with Product2[String, String] with HasThriftStructCodec3[LogEntry] with Serializable

    Prefer the companion object's com.twitter.finagle.zipkin.thriftscala.LogEntry.apply for construction if you don't need to specify passthrough fields.

  2. sealed trait ResultCode extends ThriftEnum with Serializable
    Annotations
    @Generated()
  3. trait Scribe[+MM[_]] extends ThriftService
    Annotations
    @Generated()
  4. class Scribe$FinagleClient extends Scribe[Future]
    Annotations
    @Generated()
  5. class Scribe$FinagleService extends Service[Array[Byte], Array[Byte]]
    Annotations
    @Generated()

Value Members

  1. object LogEntry extends ThriftStructCodec3[LogEntry] with Serializable
  2. object ResultCode extends Product with Serializable
    Annotations
    @Generated()
  3. object Scribe

Ungrouped