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

Failure

Companion object Failure

final class Failure extends Exception with NoStackTrace with HasLogLevel with FailureFlags[Failure]

Base exception for all Finagle originated failures. These are Exceptions, but with additional sources and flags. Sources describe the origins of the failure to aid in debugging and flags mark attributes of the Failure (e.g. Restartable).

Linear Supertypes

FailureFlags[Failure], HasLogLevel, NoStackTrace, Exception, Throwable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Failure
FailureFlags
HasLogLevel
NoStackTrace
Exception
Throwable
Serializable
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 addSuppressed(arg0: Throwable): Unit
Definition Classes
Throwable
final def asInstanceOf[T0]: T0
Definition Classes
Any
def asNonRetryable: Failure
This as a non-retryable failure.
This as a non-retryable failure. This does not mutate.
Definition Classes
FailureFlags
def asRejected: Failure
This as a rejected failure.
This as a rejected failure. This does not mutate.
Definition Classes
FailureFlags
val cause: Option[Throwable]
def chained: Failure
A new failure with the current Failure as cause.
def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def copyWithFlags(newFlags: Long): Failure
A copy of this object with the given flags replacing the current flags.
A copy of this object with the given flags replacing the current flags. The caller of this method should check to see if a copy is necessary before calling.
As this is an internal API, the other Throwable fields such as the cause and stack trace should be handled by callers.
Attributes
protected
Definition Classes
Failure → FailureFlags
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(a: Any): Boolean
Definition Classes
Failure → AnyRef → Any
def fillInStackTrace(): Throwable
Definition Classes
NoStackTrace → Throwable
def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
val flags: Long
Definition Classes
Failure → FailureFlags
def getCause(): Throwable
Definition Classes
Throwable
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def getLocalizedMessage(): String
Definition Classes
Throwable
def getMessage(): String
Definition Classes
Throwable
def getSource(key: Failure.Source.Value): Option[AnyRef]
Returns a source for a given key, if it exists.
def getStackTrace(): Array[StackTraceElement]
Definition Classes
Throwable
final def getSuppressed(): Array[Throwable]
Definition Classes
Throwable
def hashCode(): Int
Definition Classes
Failure → AnyRef → Any
def initCause(arg0: Throwable): Throwable
Definition Classes
Throwable
def isFlagged(which: Long): Boolean
Test if this is flagged with a particular set of flags
Test if this is flagged with a particular set of flags
Definition Classes
FailureFlags
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
val logLevel: Level
Definition Classes
Failure → HasLogLevel
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def printStackTrace(arg0: PrintWriter): Unit
Definition Classes
Throwable
def printStackTrace(arg0: PrintStream): Unit
Definition Classes
Throwable
def printStackTrace(): Unit
Definition Classes
Throwable
def setStackTrace(arg0: Array[StackTraceElement]): Unit
Definition Classes
Throwable
def show: Throwable
A Throwable appropriate for user presentation (e.g., for stats, or to return from a user's Service.)
A Throwable appropriate for user presentation (e.g., for stats, or to return from a user's Service.)
Show may return this.
val sources: Map[Failure.Source.Value, AnyRef]
Attributes
protected
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
Failure → Throwable → AnyRef → Any
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()
def withLogLevel(level: Level): Failure
Creates a new Failure with the given logging Level.
Creates a new Failure with the given logging Level.
Note: it is not guaranteed that all Failures are logged within finagle and this only applies to ones that are.
def withSource(key: Failure.Source.Value, value: AnyRef): Failure
Creates a new Failure with the given key value pair prepended to sources.

Packages

Failure

Companion object Failure

final class Failure extends Exception with NoStackTrace with HasLogLevel with FailureFlags[Failure]

Value Members

Inherited from FailureFlags[Failure]

Inherited from HasLogLevel

Inherited from NoStackTrace

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Failure

Companion object Failure

final class Failure extends Exception with NoStackTrace with HasLogLevel with FailureFlags[Failure]

Value Members

Inherited from FailureFlags[Failure]

Inherited from HasLogLevel

Inherited from NoStackTrace

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Failure