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 netty4

    Package netty4 implements the bottom finagle primitives: com.twitter.finagle.Server and a client transport in terms of the netty4 event loop.

    Package netty4 implements the bottom finagle primitives: com.twitter.finagle.Server and a client transport in terms of the netty4 event loop.

    Definition Classes
    finagle
  • package ssl
    Definition Classes
    netty4
  • package client
    Definition Classes
    ssl
  • ExternalClientEngineFactory
  • Netty4ClientEngineFactory
  • SslClientVerificationHandler
  • package server
    Definition Classes
    ssl

package client

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

  1. final class Netty4ClientEngineFactory extends SslClientEngineFactory

    This engine factory uses Netty 4's SslContextBuilder.

    This engine factory uses Netty 4's SslContextBuilder. It is the recommended path for using native SSL/TLS engines with Finagle.

Value Members

  1. object ExternalClientEngineFactory extends SslClientEngineFactory

    This engine factory is intended to be used *only* by clients that talk to outside web servers.

    This engine factory is intended to be used *only* by clients that talk to outside web servers. It ignores some of the parameters passed in as part of the SslClientConfiguration, in order to severely limit the number of OpenSslContext objects which get created.

    There are four types of engines which can be created by this engine factory: 1. http/1.1 with trust credential checking done against system certs 2. http/1.1 with no trust credential checking done (insecure) 3. h2 with trust credential checking done against system certs 4. h2 with no trust credential checking done (insecure)

    Note

    KeyCredentials, CipherSuites, and Protocols values are all ignored with this engine factory and are treated as if they were left as Unspecified.

  2. object Netty4ClientEngineFactory
  3. object SslClientVerificationHandler

Ungrouped