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 http
    Definition Classes
    finagle
  • package codec
    Definition Classes
    http
  • package exp
    Definition Classes
    http
  • package filter
    Definition Classes
    http
  • package netty3
    Definition Classes
    http
  • package param
    Definition Classes
    http
  • package path
    Definition Classes
    http
  • ->
  • /
  • /:
  • :&
  • :?
  • DoubleParamMatcher
  • IntParamMatcher
  • Integer
  • Long
  • LongParamMatcher
  • Numeric
  • ParamMatcher
  • Path
  • Root
  • ~
  • package service
    Definition Classes
    http
  • package util
    Definition Classes
    http

package path

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class /(parent: Path, child: String) extends Path with Product with Serializable

    Path separator extractor: Path("/1/2/3/test.json") match { case Root / "1" / "2" / "3" / "test.json" => ...

  2. case class :?(path: Path, params: ParamMap) extends Product with Serializable
  3. abstract class DoubleParamMatcher extends AnyRef

    Double param extractor: object Latitude extends DoubleParamMatcher("lat") (Path(request.path) :? request.params) match { case Root / "closest" :? Latitude("lat") => ...

  4. abstract class IntParamMatcher extends AnyRef

    Int param extractor: object Page extends IntParamMatcher("page") (Path(request.path) :? request.params) match { case Root / "blog" :? Page(page) => ...

  5. abstract class LongParamMatcher extends AnyRef

    Long param extractor: object UserId extends LongParamMatcher("user_id") (Path(request.path) :? request.params) match { case Root / "user" :? UserId(userId) => ...

  6. class Numeric[A <: AnyVal] extends AnyRef
    Attributes
    protected
  7. abstract class ParamMatcher extends AnyRef

    Param extractor: object ScreenName extends ParamMatcher("screen_name") (Path(request.path) :? request.params) match { case Root / "user" :? ScreenName(screenName) => ...

  8. abstract class Path extends AnyRef

    Base class for path extractors.

Value Members

  1. object ->

    HttpMethod extractor

  2. object /:

    Path separator extractor: Path("/1/2/3/test.json") match { case "1" /: "2" /: _ => ...

  3. object :&

    Multiple param extractor: object A extends ParamMatcher("a") object B extends ParamMatcher("b") (Path(request.path) :? request.params) match { case Root / "user" :? A(a) :& B(b) => ...

  4. object Integer extends Numeric[Int]

    Integer extractor: Path("/user/123") match { case Root / "user" / Int(userId) => ...

  5. object Long extends Numeric[scala.Long]

    Long extractor: Path("/user/123") match { case Root / "user" / Long(userId) => ...

  6. object Path
  7. object Root extends Path with Product with Serializable

    Root extractor: Path("/") match { case Root => ...

    Root extractor: Path("/") match { case Root => ... }

  8. object ~

    File extension extractor

Ungrouped