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 exp

    Package exp contains experimental code.

    Package exp contains experimental code. This can be removed or stabilized (moved elsewhere) at any time.

    Definition Classes
    finagle
  • package fiber_scheduler
    Definition Classes
    exp
  • package routing
    Definition Classes
    exp
  • Field
  • Fields
  • Message
  • MessageField
  • Request
  • Response
  • Route
  • RouteField

package routing

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed abstract class Field[+T] extends AnyRef

    The key associated with a field value of type T.

    The key associated with a field value of type T.

    T

    The type of value associated with this message field key.

  2. sealed abstract class Message[+T] extends FieldMap

    A contract for a container envelope for a value, which can allow for setting extra field metadata associated with the value.

  3. abstract class MessageField[+T] extends Field[T]

    The key associated with a Message field.

    The key associated with a Message field.

    T

    The type of value associated with this message field key.

  4. final class Request[+T] extends Message[T]

    A contract for a container envelope for a request value, which can allow for setting extra field metadata associated with the value.

  5. final class Response[+T] extends Message[T]

    A contract for a container envelope for a response value, which can allow for setting extra field metadata associated with the value.

  6. abstract class RouteField[+T] extends Field[T]

    The key associated with a Route field.

    The key associated with a Route field.

    T

    The type of value associated with this message field key.

Value Members

  1. object Fields
  2. object Request
  3. object Response
  4. object Route extends Serializable

Ungrouped