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 httpproxy

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

AbstractCodec

AbstractNamer

AbstractResolver

Addr

Address

Addresses

Addrs

Announcement

Announcer

AnnouncerForumInvalid

AnnouncerNotFoundException

ApiException

BackupRequestLost

CanStackFrom

CancelledConnectionException

CancelledRequestException

ChannelBufferUsageException

ChannelClosedException

ChannelException

ChannelWriteException

Client

ClientCodecConfig

ClientConnection

Codec

CodecFactory

ConnectionFailedException

ConnectionRefusedException

Deadline

Dentry

DroppedWriteException

Dtab

DtabBuilder

FactoryToService

FailResolver

FailedFastException

Failure

FailureFlags

Filter

FixedInetResolver

GlobalRequestTimeoutException

Group

HasRemoteInfo

InconsistentStateException

IndividualRequestTimeoutException

InetResolver

LabelledGroup

ListeningServer

MultipleAnnouncersPerSchemeException

MultipleResolversPerSchemeException

MutableGroup

Name

NameTree

Namer

NegResolver

NilResolver

NoBrokersAvailableException

NotServableException

NotShardableException

NullServer

Path

ProxyAnnouncement

ReadTimedOutException

RefusedByRateLimiter

RequestException

RequestTimeoutException

Resolver

ResolverAddressInvalid

ResolverNotFoundException

Resolvers

Server

ServerCodecConfig

Service

ServiceClosedException

ServiceException

ServiceFactory

ServiceFactoryProxy

ServiceFactoryWrapper

ServiceNamer

ServiceNotAvailableException

ServiceProxy

ServiceTimeoutException

ShardNotAvailableException

SimpleFilter

SourcedException

SslHandshakeException

SslHostVerificationException

Stack

StackBuilder

Stackable

Status

StreamClosedException

TimeoutException

TooManyConcurrentRequestsException

TooManyWaitersException

TransportException

UnknownChannelException

WriteException

WriteTimedOutException

stack

com.twitter.finagle

ChannelWriteException

Companion object ChannelWriteException

case class ChannelWriteException(ex: Option[Throwable]) extends ChannelException with WriteException with NoStackTrace with Product with Serializable

Default implementation for WriteException that wraps an underlying exception.

Linear Supertypes

Serializable, Product, Equals, NoStackTrace, WriteException, ChannelException, HasLogLevel, SourcedException, HasRemoteInfo, Exception, Throwable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ChannelWriteException
Serializable
Product
Equals
NoStackTrace
WriteException
ChannelException
HasLogLevel
SourcedException
HasRemoteInfo
Exception
Throwable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new ChannelWriteException(underlying: Throwable)
new ChannelWriteException(ex: Option[Throwable])

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 clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val ex: Option[Throwable]
def exceptionMessage(): String

Definition Classes
ChannelException → HasRemoteInfo
def fillInStackTrace(): NoStackTrace

Definition Classes
ChannelWriteException → NoStackTrace → Throwable
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getCause(): Throwable

Definition Classes
Throwable
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getLocalizedMessage(): String

Definition Classes
Throwable
def getMessage(): String

Definition Classes
HasRemoteInfo → Throwable
def getStackTrace(): Array[StackTraceElement]

Definition Classes
ChannelWriteException → Throwable
final def getSuppressed(): Array[Throwable]

Definition Classes
Throwable
def initCause(arg0: Throwable): Throwable

Definition Classes
Throwable
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def logLevel: Level

Definition Classes
ChannelException → HasLogLevel
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def printStackTrace(arg0: PrintWriter): Unit

Definition Classes
Throwable
def printStackTrace(arg0: PrintStream): Unit

Definition Classes
Throwable
def printStackTrace(): Unit

Definition Classes
Throwable
def remoteAddress: SocketAddress
The SocketAddress of the remote peer.
The SocketAddress of the remote peer.
returns
null if not available.

Definition Classes
ChannelException
def remoteInfo(): RemoteInfo

Definition Classes
HasRemoteInfo
val serviceName: String

Definition Classes
SourcedException
def setStackTrace(arg0: Array[StackTraceElement]): Unit

Definition Classes
Throwable
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
Throwable → AnyRef → Any
def underlying: Throwable
The cause of this exception, or null if there is no cause.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Packages

ChannelWriteException

Companion object ChannelWriteException

case class ChannelWriteException(ex: Option[Throwable]) extends ChannelException with WriteException with NoStackTrace with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from NoStackTrace

Inherited from WriteException

Inherited from ChannelException

Inherited from HasLogLevel

Inherited from SourcedException

Inherited from HasRemoteInfo

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

ChannelWriteException 

Companion object ChannelWriteException

case class ChannelWriteException(ex: Option[Throwable]) extends ChannelException with WriteException with NoStackTrace with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from NoStackTrace

Inherited from WriteException

Inherited from ChannelException

Inherited from HasLogLevel

Inherited from SourcedException

Inherited from HasRemoteInfo

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

ChannelWriteException