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 client

package server

package session

ApplicationProtocols

ApplicationProtocolsConfig

CipherSuites

CipherSuitesConfig

ClientAuth

ClientAuthConfig

Engine

KeyCredentials

KeyCredentialsConfig

OpportunisticTls

OpportunisticTlsConfig

Protocols

ProtocolsConfig

SslConfigurationException

TrustCredentials

TrustCredentialsConfig

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

com.twitter.finagle

ssl

package ssl

Ordering

Alphabetic

Visibility

Public
All

Type Members

sealed trait ApplicationProtocols extends AnyRef
ApplicationProtocols represent the prioritized list of Application-Layer Protocol Negotiation (ALPN) or Next Protocol Negotiation (NPN) values that a configured TLS Engine should support.
ApplicationProtocols represent the prioritized list of Application-Layer Protocol Negotiation (ALPN) or Next Protocol Negotiation (NPN) values that a configured TLS Engine should support.

Note
Currently supported values include IANA Registered Application-Layer Protocol Negotiation (ALPN) IDs and "spdy/3.1" which is commonly used with Next Protocol Negotiation (NPN).
,
Java users: See ApplicationProtocolsConfig.
final class ApplicationProtocolsConfig extends AnyRef
Java APIs for ApplicationProtocols.
sealed trait CipherSuites extends AnyRef
CipherSuites represent the collection of prioritized cipher suites that should be enabled for a TLS Engine.
CipherSuites represent the collection of prioritized cipher suites that should be enabled for a TLS Engine. A cipher suite, for protocols prior to TLSv1.3, is a combination of various algorithms for items such as key exchange, authentication type, bulk encryption algorithm, and message authentication code.

Note
Java users: See CipherSuitesConfig.
final class CipherSuitesConfig extends AnyRef
Java APIs for CipherSuites.
sealed trait ClientAuth extends AnyRef
ClientAuth represents whether one-way or two-way TLS should be used with a TLS Engine.
ClientAuth represents whether one-way or two-way TLS should be used with a TLS Engine. One-way TLS authentication is where the server sends its certificate to the client for verification. Two-way or mutual TLS is where the server sends its certificate to the client and the client sends its certificate to the server for verification.
This parameter is only used by SslServerConfiguration.

Note
Not all engine factories provide support for client authentication, especially with some underlying native engines.
,
Java users: See ClientAuthConfig.
final class ClientAuthConfig extends AnyRef
Java APIs for ClientAuth.
case class Engine(self: SSLEngine, handlesRenegotiation: Boolean = false, certId: String = "<unknown>") extends Product with Serializable
sealed trait KeyCredentials extends AnyRef
KeyCredentials represent the items necessary for this configured TLS Engine to authenticate itself to a remote peer.
KeyCredentials represent the items necessary for this configured TLS Engine to authenticate itself to a remote peer. This generally includes an X.509 certificate and a private key.

Note
Java users: See KeyCredentialsConfig.
final class KeyCredentialsConfig extends AnyRef
Java APIs for KeyCredentials.
final class OpportunisticTlsConfig extends AnyRef
Java APIs for OpportunisticTls.
sealed trait Protocols extends AnyRef
Protocols represent the versions of the TLS protocol which should be enabled with a given TLS Engine.
Protocols represent the versions of the TLS protocol which should be enabled with a given TLS Engine.

Note
Java users: See ProtocolsConfig.
final class ProtocolsConfig extends AnyRef
Java APIs for Protocols.
case class SslConfigurationException(cause: Throwable) extends SslException with Product with Serializable
SslConfigurationException is an exception which is thrown by a particular engine factory when the engine factory does not support the collection of parameters specified by the SslClientConfiguration or the SslServerConfiguration.
sealed trait TrustCredentials extends AnyRef
TrustCredentials represent the items necessary for this configured TLS Engine to verify a remote peer's credentials.
TrustCredentials represent the items necessary for this configured TLS Engine to verify a remote peer's credentials.

Note
Java users: See TrustCredentialsConfig.
final class TrustCredentialsConfig extends AnyRef
Java APIs for TrustCredentials.

Packages

ssl

package ssl

Type Members

Value Members

Ungrouped

Packages

ssl 

package ssl

Type Members

Value Members

Ungrouped

ssl