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.

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 addr

Definition Classes: finagle

package builder

Definition Classes: finagle

package client

Definition Classes: finagle

package context

Definition Classes: finagle

package core

Definition Classes: finagle

package dispatch

Definition Classes: finagle

ClientDispatcher

GenPipeliningDispatcher

GenSerialClientDispatcher

GenSerialServerDispatcher

PipeliningDispatcher

SerialClientDispatcher

SerialServerDispatcher

StalledPipelineTimeout

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 factory

Definition Classes: finagle

package filter

Definition Classes: finagle

package liveness

Definition Classes: finagle

package loadbalancer

This package implements client side load balancing algorithms.

As an end-user, see the Balancers API to create instances which can be used to configure a Finagle client with various load balancing strategies.

As an implementor, each algorithm gets its own subdirectory and is exposed via the Balancers object. Several convenient traits are provided which factor out common behavior and can be mixed in (i.e. Balancer, DistributorT, NodeT, and Updating).

Definition Classes: finagle

package namer

Definition Classes: finagle

package naming

Definition Classes: finagle

package offload

Definition Classes: finagle

package param

Defines common com.twitter.finagle.Stack.Param's shared between finagle clients and servers.

Definition Classes: finagle

package pool

Definition Classes: finagle

package pushsession

Definition Classes: finagle

package server

Definition Classes: finagle

package service

Definition Classes: finagle

package ssl

Definition Classes: finagle

package stats

Definition Classes: finagle

package thrift

Definition Classes: finagle

package tracing

Definition Classes: finagle

package transport

Definition Classes: finagle

package util

Definition Classes: finagle

com.twitter.finagle

dispatch

package dispatch

Ordering

Alphabetic

Visibility

Public
All

Type Members

abstract class ClientDispatcher[Req, Rep, In, Out] extends Service[Req, Rep]
Dispatches requests.
Dispatches requests.

Note
this construct makes no guarantees with regard to concurrent dispatches. For implementations that require serial dispatch see the GenSerialClientDispatcher.
abstract class GenPipeliningDispatcher[Req, Rep, In, Out, T] extends GenSerialClientDispatcher[Req, Rep, In, Out]
A generic pipelining dispatcher, which assumes that servers will respect normal pipelining semantics, and that replies will be sent in the same order as requests were sent.
A generic pipelining dispatcher, which assumes that servers will respect normal pipelining semantics, and that replies will be sent in the same order as requests were sent. Exploits GenSerialClientDispatcher to serialize requests.
Because many requests might be sharing the same transport, Futures returned by GenPipeliningDispatcher#apply are masked, and will only propagate the interrupt if the future doesn't return after a configurable amount of time after the interruption. This ensures that interrupting a Future in one request won't change the result of another request unless the connection is stuck, and does not look like it will make progress. Use StalledPipelineTimeout to configure this timeout.
abstract class GenSerialClientDispatcher[Req, Rep, In, Out] extends Service[Req, Rep]
Dispatches requests one at a time; concurrent requests are queued.
abstract class GenSerialServerDispatcher[Req, Rep, In, Out] extends Closable
A generic version of SerialServerDispatcher, allowing the implementor to furnish custom dispatchers & handlers.
class PipeliningDispatcher[Req, Rep] extends GenPipeliningDispatcher[Req, Rep, Req, Rep, Unit]
class SerialClientDispatcher[Req, Rep] extends GenSerialClientDispatcher[Req, Rep, Req, Rep]
class SerialServerDispatcher[Req, Rep] extends GenSerialServerDispatcher[Req, Rep, Rep, Req]
Dispatch requests from transport one at a time, queueing concurrent requests.
Dispatch requests from transport one at a time, queueing concurrent requests.
Transport errors are considered fatal; the service will be released after any error.
case class StalledPipelineTimeout(timeout: Duration) extends Product with Serializable
A class eligible for configuring a timeout com.twitter.util.Duration to consider a pipeline to have stalled (stopped making progress after an initial interruption).

Value Members

object ClientDispatcher
object GenPipeliningDispatcher
object GenSerialClientDispatcher
object GenSerialServerDispatcher
object StalledPipelineTimeout extends Serializable

Packages

dispatch 

package dispatch

Type Members

Value Members

Ungrouped

dispatch