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

package thrift

Definition Classes: finagle

package tracing

Definition Classes: finagle

package transport

Definition Classes: finagle

package util

Definition Classes: finagle

AsyncLatch

ByteArrays

Chan

CloseNotifier

DefaultTimer

Drv

ExitGuard

HashedWheelTimer

InetSocketAddressUtil

LoadService

LoadedReporterFactory

NullReporterFactory

OnReady

Proc

ReporterFactory

Ring

Rng

Rngs

Showable

StackRegistry

com.twitter.finagle

util

package util

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

util
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Type Members

class AsyncLatch extends AnyRef
A construct providing latched, asynchronous execution of side-effecting functions.
A construct providing latched, asynchronous execution of side-effecting functions. com.twitter.finagle.util.AsyncLatch#await does not block, but the execution of functions passed to it may be delayed. That is, because the latch guarantees serial, non-concurrent execution, functions passed to await may have to wait until both of the following conditions are met:
1. No other functions are being executed 2. The latch's count is zero
Thus, calling com.twitter.finagle.util.AsyncLatch#incr will cause subsequent functions passed to com.twitter.finagle.util.AsyncLatch#await to be delayed until the count is decremented to zero. Once the count is zero, functions are executed in the order that they are provided to await.
trait Chan [-T] extends AnyRef
trait CloseNotifier extends AnyRef
Allows resources to register their handlers to be invoked when service is closing.
trait Drv extends (Rng) ⇒ Int
trait OnReady extends AnyRef
A base type for something that signals its readiness asynchronously.
trait Proc [-T] extends Chan[T]
A Proc is a process that can receive messages.
A Proc is a process that can receive messages. Procs guarantee that exactly one message is delivered at a time, and that they are delivered in the order received.
They can be thought of as featherweight actors.
trait ReporterFactory extends (String, Option[SocketAddress]) ⇒ Monitor
class Ring extends AnyRef
Class Ring implements a hash ring.
Class Ring implements a hash ring. Given an array mapping indices to positions, the ring supplies the reverse mapping: to which index does a position belong?
Its distinguishing feature is that Ring can pick random positions in a range. (And then map them to their corresponding indices.) Ring can also pick without replacement two elements from a range.
```
val r = new Ring(Array(1,5,20))
r(0)  == 0
r(1)  == 0
r(2)  == 1
r(5)  == 1
r(6)  == 2
r(20) == 2
r(21) == 0 // Wraps around; it's a ring!
```
trait Rng extends AnyRef
A random number generator.
A random number generator. Java's divergent interfaces forces our hand here: ThreadLocalRandom does not conform to java.util.Random. We bridge this gap.
trait Showable [-T] extends AnyRef
Trait showable is a type-class for showing parseable representations of objects.
trait StackRegistry extends AnyRef
A registry that allows the registration of a string identifier with a a com.twitter.finagle.Stack and its params.
A registry that allows the registration of a string identifier with a a com.twitter.finagle.Stack and its params. This is especially useful in keeping a process global registry of Finagle clients and servers for dynamic introspection.

Value Members

val DefaultLogger: Logger
object ByteArrays
object CloseNotifier
object DefaultTimer
Retained for compatibility.
Retained for compatibility. Prefer HashedWheelTimer.
object Drv
Create discrete random variables representing arbitrary distributions.
object ExitGuard
ExitGuard prevents the process from exiting normally by use of a nondaemon thread whenever there is at least one guarder.
object HashedWheelTimer
A HashedWheelTimer that uses org.jboss.netty.util.HashedWheelTimer under the hood.
A HashedWheelTimer that uses org.jboss.netty.util.HashedWheelTimer under the hood. Prefer using a single instance per application, the default instance is HashedWheelTimer.Default.
object InetSocketAddressUtil
object LoadService
Load a singleton class in the manner of java.util.ServiceLoader.
Load a singleton class in the manner of java.util.ServiceLoader. It is more resilient to varying Java packaging configurations than ServiceLoader.

See also
com.twitter.app.LoadService in util-app
object LoadedReporterFactory extends ReporterFactory
object NullReporterFactory extends ReporterFactory
object Proc
object Ring
object Rng
See Rngs for Java compatible APIs.
object Rngs
Java compatible forwarders.
object Showable
object StackRegistry

Packages

util

package util

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

util 

package util

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

util