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

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

AnnouncerForumInvalid

AnnouncerNotFoundException

ApiException

CanStackFrom

CancelledConnectionException

CancelledRequestException

ChannelBufferUsageException

ChannelClosedException

ChannelException

ChannelWriteException

Client

ClientConnection

ConnectionFailedException

ConnectionRefusedException

Dentry

DroppedWriteException

GlobalRequestTimeoutException

Group

HasRemoteInfo

InconsistentStateException

IndividualRequestTimeoutException

MultipleAnnouncersPerSchemeException

MultipleResolversPerSchemeException

NoBrokersAvailableException

NotServableException

NotShardableException

NullServer

Path

ProxyAnnouncement

ProxyConnectException

ReadTimedOutException

RefusedByRateLimiter

RequestException

RequestTimeoutException

Resolver

ResolverAddressInvalid

ResolverNotFoundException

Resolvers

Server

Service

ServiceClosedException

ServiceException

ServiceFactory

ServiceFactoryProxy

ServiceFactoryWrapper

ServiceNamer

ServiceNotAvailableException

ServiceProxy

ServiceTimeoutException

ShardNotAvailableException

SimpleFilter

SourcedException

SslException

SslVerificationFailedException

StreamClosedException

TimeoutException

TooManyConcurrentRequestsException

TooManyWaitersException

TransportException

UnknownChannelException

WriteException

WriteTimedOutException

stack

com.twitter.finagle

Dtab

Companion class Dtab

object Dtab extends DtabCompanionBase with Serializable

Linear Supertypes

Serializable, DtabCompanionBase, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Dtab
Serializable
DtabCompanionBase
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
var base: Dtab
The base, or "system", or "global", delegation table applies to every request in this process.
The base, or "system", or "global", delegation table applies to every request in this process. It is generally set at process startup, and not changed thereafter.
Definition Classes
DtabCompanionBase
def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
val empty: Dtab
An empty delegation table.
An empty delegation table.
Definition Classes
DtabCompanionBase
val emptyDtab: Dtab
An empty delegation table.
An empty delegation table.
Use this one if you're coming from Java.
Definition Classes
DtabCompanionBase
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
implicit val equiv: Equiv[Dtab]
Definition Classes
DtabCompanionBase
lazy val fail: Dtab
A failing delegation table.
A failing delegation table.
Definition Classes
DtabCompanionBase
def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
implicit val flaggable: Flaggable[Dtab]
implicit conversion from com.twitter.finagle.Dtab to com.twitter.app.Flaggable, allowing Dtabs to be easily used as com.twitter.app.Flags
implicit conversion from com.twitter.finagle.Dtab to com.twitter.app.Flaggable, allowing Dtabs to be easily used as com.twitter.app.Flags
Definition Classes
DtabCompanionBase
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def local: Dtab
The local, or "per-request", delegation table applies to the current Local scope which is usually defined on a per-request basis.
The local, or "per-request", delegation table applies to the current Local scope which is usually defined on a per-request basis. Finagle uses the Dtab Dtab.base ++ Dtab.local to bind Paths via a com.twitter.finagle.naming.NameInterpreter.
Local's scope is dictated by Local.
The local dtab is serialized into outbound requests when supported protocols are used. (Http, Thrift via TTwitter, Mux, and ThriftMux are among these.) The upshot is that local is defined for the entire request graph, so that a local dtab defined here will apply to downstream services as well.
Definition Classes
DtabCompanionBase
def local_=(dtab: Dtab): Unit
Definition Classes
DtabCompanionBase
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def newBuilder: DtabBuilder
Scala collection plumbing required to build new dtabs
Scala collection plumbing required to build new dtabs
Definition Classes
DtabCompanionBase
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def read(s: String): Dtab
Parse a Dtab from string s with concrete syntax
Parse a Dtab from string s with concrete syntax
```
dtab       ::= dentry ';' dtab | dentry
```
where the production dentry is from the grammar documented in Dentry.read
Definition Classes
DtabCompanionBase
def setBase(dtab: Dtab): Unit
Java API for base_=
Java API for base_=
Definition Classes
DtabCompanionBase
def setLocal(dtab: Dtab): Unit
Java API for local_=
Java API for local_=
Definition Classes
DtabCompanionBase
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def unwind[T](f: => T): T
Definition Classes
DtabCompanionBase
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Dtab

Companion class Dtab

object Dtab extends DtabCompanionBase with Serializable

Value Members

Inherited from Serializable

Inherited from DtabCompanionBase

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Dtab

Companion class Dtab

object Dtab extends DtabCompanionBase with Serializable

Value Members

Inherited from Serializable

Inherited from DtabCompanionBase

Inherited from AnyRef

Inherited from Any

Ungrouped

Dtab