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 http

Definition Classes: finagle

package http2

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 logging

Definition Classes: finagle

package memcached

Definition Classes: finagle

package mux

Package mux implements a generic RPC multiplexer with a rich protocol.

Package mux implements a generic RPC multiplexer with a rich protocol. Mux is itself encoding independent, so it is meant to use as the transport for other RPC systems (eg. thrift). In OSI terminology, it is a pure session layer.

In the below description, all numeric values are unsigned and in big-endian byte order. The schema size:4 body:10 defines the field size to be 4 bytes, followed by 10 bytes of the field body. The schema key~4 defines the field key to be defined by 4 bytes interpreted as the size of the field, followed by that many bytes comprising the field itself--it is shorthand for keysize:4 key:keysize. Groups are denoted by parenthesis; * denotes repetition of the previous schema 0 or more times, while {n} indicates repetition exactly n times. Unspecified sizes consume the rest of the frame: they may be specified only as the last field in the message.

All strings in Mux are Utf-8 encoded, and are never null-terminated.

Message framing

Messages in mux are framed with a 4-byte big-endian size header, followed by 1 byte describing the message type and a 3-byte tag; or, diagrammatically: size:4 type:1 tag:3. The remainder of the frame (size-4 bytes) contains the body. Its format depends on the message type, documented below.

Tag 0 designates a "marker" T message that expects no reply. Some messages may be split into an ordered sequence of fragments. Tag MSB=0 denotes the last message in such a sequence, making the tag namespace 23 bits. The tag is otherwise arbitrary, and is chosen by the sender of the T message.

Currently, only Tdispatch and Rdispatch messages may be split into an ordered sequence of fragments. TdispatchError message ends a Tdispatch sequence and an Rerr ends an Rdispatch sequence.

Message types, interpreted as a two's complement, 1-byte integer are numbered as follows: positive numbers are T-messages; their negative complement is the corresponding R message. T-messages greater than 63 (correspondingly R-messages smaller than -63) are session messages. The message number -128 is reserved for Rerr. All other messages are application messages. Middle boxes may forward application messages indiscriminately. Because of an early implementation bug, two aliases exist: 127 is Rerr, and -62 is Tdiscarded.

The protocol is full duplex: both the server and client may send T messages initiating an exchange.

Exchanges

Messages are designated as "T messages" or "R messages", T and R being stand-ins for transmit and receive. A T message initiates an exchange and is assigned a free tag by the sender. A reply is either an R message of the same type (Rx replies to Tx for some x), or an Rerr, indicating a session layer error. R messages are matched to their T messages by tag, and the reply concludes the exchange and frees the tag for future use. Implementations should reuse small tag numbers.

Messages

size:4 Tinit:1 tag:3 version:2 (key~4 value~4)* reinitializes a session. Clients typically send this at the beginning of the session. When doing so, the sender may issue no more T messages until the corresponding size:4 Rinit:1 tag:3 version:2 (key~4 value~4)* has been received. After the Rinit was received, all connection state has been reset (outstanding tags are invalidated) and the stream is resumed according to the newly negotiated parameters. Prior to the first Tinit, the session operates at version 1. Rinit's version field is the accepted version of the session (which may be lower than the one requested by Tinit).

size:4 Treq:1 tag:3 n:1 (key:1 value~1){n} body: initiates the request described by its body. The request body is delivered to the application. The request header contains a number of key-value pairs that describe request metadata.

Keys for Treq messages are as follows:

traceid: a 24-byte value describing the full Dapper trace id assigned by the client. The value's format is spanid:8 parentid:8 traceid:8.

2. traceflag: a bitmask describing trace flags. Currently, the only defined flag is bit 0 which enables "debug mode", asking the server to force trace sampling.

size:4 Tdispatch:1 tag:3 nctx:2 (ckey~2 cval~2){nc} dst~2 nd:2 (from~2 to~2){nd} body: implements destination dispatch. Tdispatch messages carry a set of keyed request contexts, followed by a logical destination encoded as a UTF-8 string. A delegation table follows describing rewrite rules that apply to this request.

size:4 Rreq:1 tag:3 status:1 body: replies to a request. Status codes are as follows: 0=OK; the body contains the reply. 1=ERROR; the body contains a string describing the error. 2=NACK; a negative acknowledgment, the body contains a string describing the reason.

size:4 Rdispatch:1 tag:3 status:1 nctx:2 (key~2 value~2){nctx} body: replies to a Tdispatch request. Status codes are as in Rreq. Replies can include request contexts. MuxFailure flags are currently sent via Rdispatch contexts under the "MuxFailure" key. See the MuxFailure flags section below.

size:4 Rerr:1 tag:3 why: indicates that the corresponding T message produced an error. Rerr is specifically for server errors: the server failed to interpret or act on the message. The body carries a string describing the error.

size:4 Tdrain:1 tag:3 is a request sent by the server telling the client to stop sending new requests. A client acknowledges this with an Rdrain message.

size:4 Tping:1 tag:3 is sent by either party to check the liveness of its peer; these should be responded to immediately with a Rping message.

size:4 Tdiscarded:1 tag:3 discard_tag:3 why: is a marker message and therefore has a tag value of 0. discard_tag indicates the tag of the Tdispatch to be discarded by the client. This can be used as a hint for early termination. Why is a string describing why the request was discarded. Note that it does *not* free the server from the obligation of replying to the original Treq.

size:4 Tlease:1 tag:3 unit:1 howmuch:8 is a marker message indicating that a lease has been issued for howmuch units. As a marker message, its tag value must be 0. Unit '0' is reserved for duration in milliseconds. Whenever a lease has not been issued, a client can assume it holds an indefinite lease. Adhering to the lease is optional, but the server may reject requests or provide degraded service should the lease expire. This is used by servers to implement features like garbage collection avoidance.

MuxFailure Flags

Failure flags are read and written as an 8 byte integer. Unrecognized flags will be ignored silently, but should all be considered reserved for future use.

Flag Value Meaning Restartable 1 << 0 Request is safe to re-issue Rejected 1 << 1 Request was rejected/Nacked by the server NonRetryable 1 << 2 Request should not be retried

Security

TLS is supported via three mechanisms: - Explicit and exclusive TLS. This pathway involves requiring the establishment of TLS immediately after establishing the socket connection. This is configured by adding TLS configuration to the client or server and not configuring opportunistic TLS or TLS snooping (see below).

- Negotiated Opportunistic TLS. This pathway involves starting the connection as cleartext and the client and server subsequently negotiate a TLS level via the handshake. Based on that handshake the connection is either left as cleartext or upgraded to TLS. This is configured by adding TLS configuration and also configuring an opportunistic TLS level but not configuring TLS snooping.

In this pathway there are three configuration options:

Off signals that TLS is not supported by this peer
Desired signals that TLS is preferred but not required by this peer
Required signals that this peer will only allow the session to continue over TLS

- TLS snooping. This pathway allows a server to use TLS either by performing a TLS handshake immediately after the socket is established or by starting the session as cleartext or using the negotiated pathway described above. If the session is started as a TLS session the headers that drive the opportunistic TLS pathway are ignored.

Note that the server may still require TLS but leaves the option to start TLS immediately after establishing the socket or starting cleartext and requiring TLS via the opportunistic TLS pathway described above.

Definition Classes: finagle

package mysql

Definition Classes: finagle

package namer

Definition Classes: finagle

package naming

Definition Classes: finagle

package netty4

Package netty4 implements the bottom finagle primitives: com.twitter.finagle.Server and a client transport in terms of the netty4 event loop.

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

ClientAdmissionControlParams

ClientParams

ClientSessionParams

ClientTransportParams

CommonParams

DefaultLoadBalancingParams

ExceptionStatsHandler

ServerAdmissionControlParams

ServerSessionParams

ServerTransportParams

SessionParams

SessionPoolingParams

SessionQualificationParams

WithClientAdmissionControl

WithClientSession

WithClientTransport

WithDefaultLoadBalancer

WithServerAdmissionControl

package partitioning

Definition Classes: finagle

package pool

Definition Classes: finagle

package postgresql

Definition Classes: finagle

package pushsession

Definition Classes: finagle

package redis

Definition Classes: finagle

package scribe

Definition Classes: finagle

package server

Definition Classes: finagle

package serverset2

Definition Classes: finagle

package service

Definition Classes: finagle

package ssl

Definition Classes: finagle

package stats

Definition Classes: finagle

package thrift

Please use the new interface, com.twitter.finagle.Thrift, for constructing Thrift clients and servers.

Deprecation

Please use the new interface, com.twitter.finagle.Thrift, for constructing Thrift clients and servers.

Thrift codecs

We provide client and server protocol support for the framed protocol. The public implementations are defined on the Thrift object:

The type of the server codec is Service[Array[Byte], Array[Byte]] and the client codecs are Service[ThriftClientRequest, Array[Byte]]. The service provided is that of a "transport" of thrift messages (requests and replies) according to the protocol chosen. This is why the client codecs need to have access to a thrift ProtocolFactory.

These transports are used by the services produced by the finagle thrift codegenerator.

val service: Service[ThriftClientRequest, Array[Byte]] = ClientBuilder()
  .hosts("foobar.com:123")
  .stack(Thrift.client)
  .build()

// Wrap the raw Thrift transport in a Client decorator. The client
// provides a convenient procedural interface for accessing the Thrift
// server.
val client = new Hello.ServiceToClient(service, protocolFactory)

In this example, Hello is the thrift interface, and the inner class ServiceToClient is provided by the finagle thrift code generator.

Definition Classes: finagle

package thriftmux

Definition Classes: finagle

package toggle

Definition Classes: finagle

package tracing

Definition Classes: finagle

package transport

Definition Classes: finagle

package tunable

Definition Classes: finagle

package util

Definition Classes: finagle

package zipkin

Definition Classes: finagle

package zookeeper

Definition Classes: finagle

com.twitter.finagle

param

package param

Defines common com.twitter.finagle.Stack.Param's shared between finagle clients and servers.

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

param
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

class ClientAdmissionControlParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring the admission control modules of Finagle clients.
A collection of methods for configuring the admission control modules of Finagle clients.
A
a Stack.Parameterized client to configure
trait ClientParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for basic configuration of Finagle clients.
A collection of methods for basic configuration of Finagle clients.
A
a Stack.Parameterized client to configure
See also
https://twitter.github.io/finagle/guide/Clients.html
class ClientSessionParams[A <: Parameterized[A]] extends SessionParams[A]
A collection of methods for configuring sessions of the Finagle clients.
A collection of methods for configuring sessions of the Finagle clients.
Session might be viewed as logical connection that wraps a physical connection (i.e., transport) and controls its lifecycle. Sessions are used in Finagle to maintain liveness, requests cancellation, draining, and much more.
A
a Stack.Parameterized client to configure.
See also
SessionPoolingParams for pooling related configuration.
class ClientTransportParams[A <: Parameterized[A]] extends TransportParams[A]
A collection of methods for configuring the Transport for Finagle clients.
A collection of methods for configuring the Transport for Finagle clients.
A
a Stack.Parameterized client to configure
See also
com.twitter.finagle.param.TransportParams
trait CommonParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring common parameters (labels, stats receivers, etc) shared between Finagle clients and servers.
A collection of methods for configuring common parameters (labels, stats receivers, etc) shared between Finagle clients and servers.
A
a Stack.Parameterized server/client to configure
class DefaultLoadBalancingParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring the Load Balancing (default) module of Finagle clients.
A collection of methods for configuring the Load Balancing (default) module of Finagle clients.
A
a Stack.Parameterized client to configure
See also
https://twitter.github.io/finagle/guide/Clients.html#load-balancing
case class ExceptionStatsHandler(categorizer: stats.ExceptionStatsHandler) extends Product with Serializable
A class eligible for configuring a com.twitter.finagle.stats.ExceptionStatsHandler throughout finagle servers and clients.
A class eligible for configuring a com.twitter.finagle.stats.ExceptionStatsHandler throughout finagle servers and clients.
NB: Since the default for failures is to be scoped under "failures", if you set the default to be in another scope, it may be difficult for engineers unfamiliar with your stats to understand your service's key metrics.
case class HighResTimer(timer: util.Timer) extends Product with Serializable
A class eligible for configuring a high resolution com.twitter.util.Timer such that tasks are run tighter to their schedule.
A class eligible for configuring a high resolution com.twitter.util.Timer such that tasks are run tighter to their schedule.
timer
it is a requirement that it propagates Locals from scheduling time to execution time.
Note
it is expected that the resolution should be sub-10 milliseconds.
See also
Timer for a configuration that is appropriate for tasks that do not need fine-grained scheduling.
case class Label(label: String) extends Product with Serializable
A class eligible for configuring a label used to identify finagle clients and servers.
case class MetricBuilders(registry: Option[CoreMetricsRegistry]) extends Product with Serializable
A class eligible for configuring a com.twitter.finagle.service.CoreMetricsRegistry throughout finagle servers.
A class eligible for configuring a com.twitter.finagle.service.CoreMetricsRegistry throughout finagle servers. The CoreMetricsRegistry allows for constructing a set of essential metrics expressions, CoreMetricsRegistry is a stateful class and should be configured per-stack.
case class Monitor(monitor: util.Monitor) extends Product with Serializable
A class eligible for configuring a com.twitter.util.Monitor throughout finagle servers and clients.
case class OppTls(level: Option[Level]) extends Product with Serializable
A class eligible for configuring if a client's TLS mode is opportunistic.
A class eligible for configuring if a client's TLS mode is opportunistic. If it's not None, then the client will negotiate with the supplied level whether to use TLS or not before setting up TLS.
If it's None, it will not attempt to negotiate whether to use TLS or not with the remote peer, and if TLS is configured, the client will communicate over TLS.
Note
This param will have no effect if the client's protocol does not support OpportunisticTls.
case class ProtocolLibrary(name: String) extends Product with Serializable
A class eligible for configuring a client library name used to identify which client library a client is using.
case class Reporter(reporter: ReporterFactory) extends Product with Serializable
A class eligible for configuring a com.twitter.finagle.util.ReporterFactory throughout finagle servers and clients.
case class ResponseClassifier(responseClassifier: service.ResponseClassifier) extends Product with Serializable
A class eligible for configuring a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.
A class eligible for configuring a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.
This allows developers to give Finagle the additional application specific knowledge necessary in order to properly classify them. Without this, Finagle can only safely make judgements about the transport level failures.
As an example take an HTTP client that receives a response with a 500 status code back from a server. To Finagle this is a successful request/response based solely on the transport level. The application developer may want to treat all 500 status codes as failures and can do so via a com.twitter.finagle.service.ResponseClassifier.
It is a PartialFunction and as such multiple classifiers can be composed together via PartialFunction.orElse.
Note
If unspecified, the default classifier is com.twitter.finagle.service.ResponseClassifier.Default which is a total function fully covering the input domain.
See also
com.twitter.finagle.http.service.HttpResponseClassifier for some HTTP classification tools.
class ServerAdmissionControlParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring the server-side admission control modules of Finagle servers.
A collection of methods for configuring the server-side admission control modules of Finagle servers.
A
a Stack.Parameterized server to configure
class ServerSessionParams[A <: Parameterized[A]] extends SessionParams[A]
A collection of methods for configuring sessions of the Finagle servers.
A collection of methods for configuring sessions of the Finagle servers.
Session might be viewed as logical connection that wraps a physical connection (i.e., transport) and controls its lifecycle. Sessions are used in Finagle to maintain liveness, requests cancellation, draining, and much more.
A
a Stack.Parameterized server to configure.
class ServerTransportParams[A <: Parameterized[A]] extends TransportParams[A]
A collection of methods for configuring the Transport for Finagle servers.
A collection of methods for configuring the Transport for Finagle servers.
A
a Stack.Parameterized server to configure
See also
com.twitter.finagle.param.TransportParams
class SessionParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring sessions of Finagle clients and servers.
A collection of methods for configuring sessions of Finagle clients and servers.
Session might be viewed as logical connection that wraps a physical connection (i.e., transport) and controls its lifecycle. Sessions are used in Finagle to maintain liveness, requests cancellation, draining, and much more.
A
a Stack.Parameterized client or server to configure
class SessionPoolingParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring the Pooling module of Finagle clients.
A collection of methods for configuring the Pooling module of Finagle clients.
A
a Stack.Parameterized client to configure
See also
https://twitter.github.io/finagle/guide/Clients.html#pooling
class SessionQualificationParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring modules which help Finagle determine the health of a session.
A collection of methods for configuring modules which help Finagle determine the health of a session. Some of these act as circuit breakers, instructing the load balancer to choose alternate paths. Effectively these enable your client to maintain higher success rates.
A
a Stack.Parameterized client to configure
See also
https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking
case class Stats(statsReceiver: StatsReceiver) extends Product with Serializable
A class eligible for configuring a com.twitter.finagle.stats.StatsReceiver throughout finagle clients and servers.
case class Timer(timer: util.Timer) extends Product with Serializable
A class eligible for configuring a com.twitter.util.Timer used throughout finagle clients and servers.
A class eligible for configuring a com.twitter.util.Timer used throughout finagle clients and servers.
timer
it is a requirement that it propagates Locals from scheduling time to execution time.
See also
HighResTimer for a configuration that needs a more fine-grained timer as this is typically implemented via a "hashed wheel timer" which is optimized for approximated I/O timeout scheduling.
case class Tracer(tracer: tracing.Tracer) extends Product with Serializable
A class eligible for configuring a com.twitter.finagle.tracing.Tracer throughout finagle servers and clients.
abstract class TransportParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring the Transport params of Finagle servers or clients.
A collection of methods for configuring the Transport params of Finagle servers or clients.
Transport is a Finagle abstraction over the network connection (i.e., a TCP connection).
A
a Stack.Parameterized server/client to configure
Note
This class is abstract in a sense that it's base for both server and client transports.
See also
ClientTransportParams for client-specific params ServerTransportParams for server-specific params
trait WithClientAdmissionControl[A <: Parameterized[A]] extends AnyRef
trait WithClientSession[A <: Parameterized[A]] extends AnyRef
Provides the withSession (client's session) API entry point.
Provides the withSession (client's session) API entry point.
See also
ClientSessionParams
trait WithClientTransport[A <: Parameterized[A]] extends AnyRef
Provides the withTransport (client's transport) API entry point.
Provides the withTransport (client's transport) API entry point.
See also
ClientTransportParams
trait WithDefaultLoadBalancer[A <: Parameterized[A]] extends AnyRef
Provides the withLoadBalancer (default balancer) API entry point.
Provides the withLoadBalancer (default balancer) API entry point.
See also
DefaultLoadBalancingParams
trait WithServerAdmissionControl[A <: Parameterized[A]] extends AnyRef
Provides the withAdmissionControl API entry point.
Provides the withAdmissionControl API entry point.
See also
ServerAdmissionControlParams
trait WithServerSession[A <: Parameterized[A]] extends AnyRef
Provides the withSession API entry point for servers.
Provides the withSession API entry point for servers.
See also
SessionParams
trait WithServerTransport[A <: Parameterized[A]] extends AnyRef
Provides the withTransport (server's transport) API entry point.
Provides the withTransport (server's transport) API entry point.
See also
ServerTransportParams
trait WithSessionPool[A <: Parameterized[A]] extends AnyRef
Provides the withSessionPool (default pool) API entry point.
Provides the withSessionPool (default pool) API entry point.
See also
SessionPoolingParams
trait WithSessionQualifier[A <: Parameterized[A]] extends AnyRef
Provides the withSessionQualifier API entry point.
Provides the withSessionQualifier API entry point.
See also
SessionQualificationParams

Value Members

object ExceptionStatsHandler extends Serializable
object HighResTimer extends Serializable
object Label extends Serializable
object MetricBuilders extends Serializable
object Monitor extends Serializable
object OppTls extends Serializable
object ProtocolLibrary extends Serializable
object Reporter extends Serializable
object ResponseClassifier extends Serializable
object Stats extends Serializable
object Timer extends Serializable
object Tracer extends Serializable

Packages

Message framing

Exchanges

Messages

MuxFailure Flags

Security

Deprecation

Thrift codecs

param

package param

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Message framing

Exchanges

Messages

MuxFailure Flags

Security

Deprecation

Thrift codecs

param

package param

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

param