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 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

CancelledCategorizer

ClientStatsReceiver

DefaultStatsReceiver

HostStatsReceiver

InMemoryHostStatsReceiver

JavaLoggerStatsReceiver

LoadedHostStatsReceiver

LoadedStatsReceiver

ServerStatsReceiver

SummarizingStatsReceiver

package thrift

Definition Classes: finagle

package tracing

Definition Classes: finagle

package transport

Definition Classes: finagle

package util

Definition Classes: finagle

com.twitter.finagle

stats

package stats

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

stats
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

trait HostStatsReceiver extends StatsReceiverProxy
A StatsReceiver type that's used for per host stats only.
A StatsReceiver type that's used for per host stats only. The underlying implementation can be any StatsReceiver. The type is used as a marker.
class InMemoryHostStatsReceiver extends HostStatsReceiver
class JavaLoggerStatsReceiver extends StatsReceiverWithCumulativeGauges
class SummarizingStatsReceiver extends StatsReceiverWithCumulativeGauges

Value Members

object CancelledCategorizer
Matcher for Throwables caused by some form of cancellation.
object ClientStatsReceiver extends StatsReceiverProxy
A client-specific StatsReceiver.
A client-specific StatsReceiver. All stats recorded using this receiver are prefixed with the string "clnt" by default.
object DefaultStatsReceiver extends StatsReceiverProxy
A "default" StatsReceiver loaded by Finagle's com.twitter.finagle.util.LoadService mechanism.
object JavaLoggerStatsReceiver
object LoadedHostStatsReceiver extends HostStatsReceiver
A com.twitter.finagle.stats.HostStatsReceiver that loads all service-loadable receivers and broadcasts stats to them.
object LoadedStatsReceiver extends StatsReceiverProxy
A com.twitter.finagle.stats.StatsReceiver that loads all service-loadable receivers and broadcasts stats to them.
object ServerStatsReceiver extends StatsReceiverProxy
A server-specific StatsReceiver.
A server-specific StatsReceiver. All stats recorded using this receiver are prefixed with the string "srv" by default.

Packages

stats

package stats

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

stats 

package stats

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

stats