Packages

package root

Definition Classes: root

package com

Start with com.twitter.finagle.

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

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 group

Definition Classes: finagle

package httpproxy

Definition Classes: finagle

package loadbalancer

Definition Classes: finagle

package exp

Aperture

Balancers

ConcurrentLoadBalancerFactory

DefaultBalancerFactory

DistributorT

HeapBalancer

LoadBalancerFactory

NodeT

RoundRobinBalancer

defaultBalancer

perHostStats

package namer

Definition Classes: finagle

package naming

Definition Classes: finagle

package netty3

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

Note: when {{com.twitter.finagle.builder.ClientBuilder}} and {{com.twitter.finagle.builder.ServerBuilder}} are deprecated, package netty3 can move into its own package, so that only the (new-style) clients and servers that depend on netty3 bring it in.

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 server

Definition Classes: finagle

package service

Definition Classes: finagle

package socks

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

loadbalancer

package loadbalancer

Ordering

Alphabetic

Visibility

Public
All

Type Members

abstract class DistributorT [Node] extends AnyRef
The base type of the load balancer distributor.
The base type of the load balancer distributor. Distributors are updated nondestructively, but, as with nodes, may share some data across updates.

Attributes
protected
class HeapBalancer [Req, Rep] extends ServiceFactory[Req, Rep] with OnReady
An efficient load balancer that operates on Activity[Set[ServiceFactory[Req, Rep]]].
abstract class LoadBalancerFactory extends AnyRef
A thin interface around a Balancer's constructor that allows Finagle to pass in context from the stack to the balancers at construction time.
A thin interface around a Balancer's constructor that allows Finagle to pass in context from the stack to the balancers at construction time.

See also
The user guide for more details.
Balancers for a collection of available balancers.
trait NodeT [Req, Rep] extends ServiceFactory[Req, Rep]
The base type of nodes over which load is balanced.
The base type of nodes over which load is balanced. Nodes define the load metric that is used; distributors like P2C will use these to decide where to balance the next request.

Attributes
protected
class RoundRobinBalancer [Req, Rep] extends ServiceFactory[Req, Rep] with Balancer[Req, Rep] with Updating[Req, Rep]
A simple round robin balancer that chooses the next backend in the list for each request.

Value Members

object Aperture
object Balancers
Constructor methods for various load balancers.
Constructor methods for various load balancers. The methods take balancer specific parameters and return a LoadBalancerFactory that allows you to easily inject a balancer into the Finagle stack via client configuration.

See also
The user guide for more details.
object ConcurrentLoadBalancerFactory
A load balancer that balances among multiple connections, useful for managing concurrency in pipelining protocols.
A load balancer that balances among multiple connections, useful for managing concurrency in pipelining protocols.
Each endpoint can open multiple connections. For N endpoints, each opens M connections, load balancer balances among N*M options. Thus, it increases concurrency of each endpoint.
object DefaultBalancerFactory extends LoadBalancerFactory
object HeapBalancer
object LoadBalancerFactory
object defaultBalancer extends GlobalFlag[String]
We expose the ability to configure balancers per-process via flags.
We expose the ability to configure balancers per-process via flags. 'heap', 'choice', and 'aperture' are valid choices for defaultBalancer. However, using this is generally not a good idea, as Finagle processes usually contain many clients. To configure the load balancer method on a client, use the configured method like so:
{{ val balancer = Balancers.aperture(...) Protocol.configured(LoadBalancerFactory.Param(balancer)) }}
object perHostStats extends GlobalFlag[Boolean]

Packages

loadbalancer 

package loadbalancer

Type Members

Value Members

Ungrouped

loadbalancer