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 filter

Definition Classes: thrift

package scribe

Definition Classes: thrift

package service

Definition Classes: thrift

package thrift

Definition Classes: thrift

package thriftscala

Definition Classes: thrift

AbstractThriftService

ClientDeserializeCtx

ClientFunction

ClientId

ClientIdRequiredFilter

DeserializeCtx

GeneratedThriftService

Headers

InputBuffers

InvalidThriftConnectionException

MethodMetadata

NoClientIdSpecifiedException

ValidateThriftService

maxReusableBufferSize

com.twitter.finagle.thrift

GeneratedThriftService

abstract class GeneratedThriftService extends AnyRef

An abstract class that all scrooge-generated thrift service objects inherit directly from, including services that extend other services.

Linear Supertypes

AnyRef, Any

Known Subclasses

Scribe

Ordering

Alphabetic
By Inheritance

Inherited

GeneratedThriftService
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new GeneratedThriftService()

Type Members

abstract type MethodPerEndpoint <: ThriftService
A type representing an implementation of this service where methods are defined as Args => Future[SuccessType]
abstract type ReqRepServicePerEndpoint <: ToThriftService
A type representing an implementation of this service where methods are defined as Service[Request[Args], Response[SuccessType]]
abstract type ServicePerEndpoint <: ToThriftService
A type representing an implementation of this service where methods are defined as Service[Args, SuccessType]

Abstract Value Members

abstract def annotations: Map[String, String]
Thrift annotations (user-defined key-value metadata) on the service
abstract def methods: Set[ThriftMethod]
The set of ThriftMethods that this service is responsible for handling
abstract def unsafeBuildFromMethods(methods: Map[ThriftMethod, Service[Request[_], Response[_]]]): ReqRepServicePerEndpoint
Generate a ReqRepServicePerEndpoint from a map of ThriftMethod -> Service[Request[Args], Response[SuccessType]] implementations.
Generate a ReqRepServicePerEndpoint from a map of ThriftMethod -> Service[Request[Args], Response[SuccessType]] implementations. This is unsafe because it does not check that the implementation associated with a ThriftMethod is typed properly until this service attempts to serve a request.
Exceptions thrown
IllegalArgumentException if an implementation is missing

Concrete 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 asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
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()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
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()

Packages

Deprecation

Thrift codecs

GeneratedThriftService

abstract class GeneratedThriftService extends AnyRef

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Deprecation

Thrift codecs

GeneratedThriftService

abstract class GeneratedThriftService extends AnyRef

Instance Constructors

Type Members

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

GeneratedThriftService