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

Definition Classes: thrift

package partitioning

Definition Classes: exp

ClientCustomStrategies

ClientCustomStrategy

ClientHashingStrategy

CustomPartitioningStrategy

HashingPartitioningStrategy

MethodBuilderCustomStrategy

MethodBuilderHashingStrategy

PartitioningParams

PartitioningStrategy

WithThriftPartitioningStrategy

com.twitter.finagle.thrift.exp

partitioning

package partitioning

Ordering

Alphabetic

Visibility

Public
Protected

Type Members

final class ClientCustomStrategy[A] extends CustomPartitioningStrategy
An API to set a custom partitioning strategy for a Thrift/ThriftMux Client.
An API to set a custom partitioning strategy for a Thrift/ThriftMux Client. For a Java-friendly way to do the same thing, see ClientCustomStrategy.create
final class ClientHashingStrategy extends HashingPartitioningStrategy
An API to set a consistent hashing partitioning strategy for a Thrift/ThriftMux Client.
An API to set a consistent hashing partitioning strategy for a Thrift/ThriftMux Client. For a Java-friendly way to do the same thing, see ClientHashingStrategy.create
sealed trait CustomPartitioningStrategy extends PartitioningStrategy
sealed trait HashingPartitioningStrategy extends PartitioningStrategy
final class MethodBuilderCustomStrategy[Req <: ThriftStructIface, Rep] extends CustomPartitioningStrategy
An API to set a custom partitioning strategy for a client MethodBuilder.
final class MethodBuilderHashingStrategy[Req <: ThriftStructIface, Rep] extends HashingPartitioningStrategy
An API to set a hashing partitioning strategy for a client MethodBuilder.
An API to set a hashing partitioning strategy for a client MethodBuilder. For a Java-friendly way to do the same thing, see MethodBuilderHashingStrategy.create
class PartitioningParams[A <: Parameterized[A]] extends AnyRef
A collection of methods for configuring the PartitioningService of Thrift clients
A collection of methods for configuring the PartitioningService of Thrift clients
A
a Stack.Parameterized client to configure
sealed trait PartitioningStrategy extends AnyRef
Service partitioning strategy to apply on the clients in order to let clients route requests accordingly.
Service partitioning strategy to apply on the clients in order to let clients route requests accordingly. Two particular partitioning strategies are going to be supported, HashingPartitioningStrategy and CustomPartitioningStrategy, each one supports both configuring Finagle Client Stack and ThriftMux MethodBuilder. Either one will need developers to provide a concrete function to give each request an indicator of destination, for example a hashing key or a partition address. Messaging fan-out is supported by leveraging RequestMerger and ResponseMerger.
trait WithThriftPartitioningStrategy[A <: Parameterized[A]] extends AnyRef
Provides the withPartitioning API entry point
Provides the withPartitioning API entry point
See also
PartitioningParams

Value Members

object ClientCustomStrategies
The java-friendly way to create a ClientCustomStrategy.
The java-friendly way to create a ClientCustomStrategy. Scala users should instead use the parallel methods on ClientCustomStrategy$.
Note
com.twitter.util.Function may be useful in helping create a scala.PartialFunction.
object ClientCustomStrategy
object ClientHashingStrategy
object MethodBuilderCustomStrategy
object MethodBuilderHashingStrategy
object PartitioningStrategy

Packages

Deprecation

Thrift codecs

partitioning

package partitioning

Type Members

Value Members

Ungrouped

partitioning