Thrift

Client and server for Apache Thrift. Thrift implements Thrift framed transport and binary protocol by default, though custom protocol factories (i.e. wire encoding) may be injected with withProtocolFactory. The client, Client[ThriftClientRequest, Array[Byte]] provides direct access to the thrift transport, but we recommend using code generation through either Scrooge or a fork of the Apache generator. A rich API is provided to support interfaces generated with either of these code generators.

The client and server uses the standard thrift protocols, with support for both framed and buffered transports. Finagle attempts to upgrade the protocol in order to ship an extra envelope carrying additional request metadata, containing, among other things, request IDs for Finagle's RPC tracing facilities.

The negotiation is simple: on connection establishment, an improbably-named method is dispatched on the server. If that method isn't found, we are dealing with a legacy thrift server, and the standard protocol is used. If the remote server is also a finagle server (or any other supporting this extension), we reply to the request, and every subsequent request is dispatched with an envelope carrying trace metadata. The envelope itself is also a Thrift struct described here.

Clients

Clients can be created directly from an interface generated from a Thrift IDL:

For example, this IDL:

service TestService {
  string query(1: string x)
}

compiled with Scrooge, generates the interface TestService.FutureIface. This is then passed into Thrift.Client.newIface:

Thrift.client.newIface[TestService.FutureIface](
  addr, classOf[TestService.FutureIface])

However note that the Scala compiler can insert the latter Class for us, for which another variant of newIface is provided:

Thrift.client.newIface[TestService.FutureIface](addr)

In Java, we need to provide the class object:

TestService.FutureIface client =
  Thrift.client.newIface(addr, TestService.FutureIface.class);

The client uses the standard thrift protocols, with support for both framed and buffered transports. Finagle attempts to upgrade the protocol in order to ship an extra envelope carrying trace IDs and client IDs associated with the request. These are used by Finagle's tracing facilities and may be collected via aggregators like Zipkin.

Servers

TestService.FutureIface must be implemented and passed into serveIface:

// An echo service
ThriftMux.server.serveIface(":*", new TestService.FutureIface {
  def query(x: String): Future[String] = Future.value(x)
})

Linear Supertypes

finagle.Server[Array[Byte], Array[Byte]], finagle.Client[ThriftClientRequest, Array[Byte]], AnyRef, Any

Type Members

case class Client(stack: Stack[ServiceFactory[ThriftClientRequest, Array[Byte]]] = Client.stack, params: Params = ...) extends StdStackClient[ThriftClientRequest, Array[Byte], Client] with WithSessionPool[Client] with WithDefaultLoadBalancer[Client] with ThriftRichClient with Product with Serializable

A ThriftMux com.twitter.finagle.Client.
A ThriftMux com.twitter.finagle.Client.

See also
Mux documentation
Thrift documentation
Configuration documentation
case class Server(stack: Stack[ServiceFactory[Array[Byte], Array[Byte]]] = Server.stack, params: Params = ...) extends StdStackServer[Array[Byte], Array[Byte], Server] with ThriftRichServer with Product with Serializable

A ThriftMux com.twitter.finagle.Server.
A ThriftMux com.twitter.finagle.Server.

See also
Thrift documentation
Configuration documentation
case class ThriftImpl(transporter: (Params) ⇒ (SocketAddress) ⇒ Transporter[ThriftClientRequest, Array[Byte]], listener: (Params) ⇒ Listener[Array[Byte], Array[Byte]]) extends Product with Serializable

The vanilla Thrift Transporter and Listener factories deviate from other protocols in the result of the netty pipeline: most other protocols expect to receive a framed Buf while vanilla thrift produces an Array[Byte].
The vanilla Thrift Transporter and Listener factories deviate from other protocols in the result of the netty pipeline: most other protocols expect to receive a framed Buf while vanilla thrift produces an Array[Byte]. This has two related motivations. First, the end result needed by the thrift implementations is an Array[Byte], which is relatively trivial to deal with and is a JVM native type so it's unnecessary to go through a Buf. By avoiding an indirection through Buf we can avoid an unnecessary copy in the netty4 pipeline that would be required to ensure that the bytes were on the heap before entering the Finagle transport types.

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
object Client extends Serializable
object Server extends Serializable
object ThriftImpl extends Serializable
final def asInstanceOf[T0]: T0

Definition Classes
Any
val client: Client
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val maxThriftBufferSize: Int
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newClient(dest: Name, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

Definition Classes
Thrift → Client
final def newClient(dest: String, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
final def newClient(dest: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
def newService(dest: Name, label: String): Service[ThriftClientRequest, Array[Byte]]

Definition Classes
Thrift → Client
final def newService(dest: String, label: String): Service[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
final def newService(dest: String): Service[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
object param
val protocolFactory: TProtocolFactory
def serve(addr: SocketAddress, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Thrift → Server
def serve(addr: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serve(addr: String, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serve(addr: SocketAddress, service: Service[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serveAndAnnounce(name: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serveAndAnnounce(name: String, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serveAndAnnounce(name: String, addr: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serveAndAnnounce(name: String, addr: String, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serveAndAnnounce(name: String, addr: SocketAddress, service: Service[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
def serveAndAnnounce(name: String, addr: SocketAddress, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

Definition Classes
Server
val server: Server
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

final def newClient(dest: Group[SocketAddress]): ServiceFactory[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
Annotations
@deprecated
Deprecated
(Since version 6.7.x) Use destination names
final def newService(dest: Group[SocketAddress]): Service[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
Annotations
@deprecated
Deprecated
(Since version 6.7.x) Use destination names
def withClientId(clientId: ClientId): Client

Annotations
@deprecated
Deprecated
(Since version 6.22.0) Use Thrift.client.withClientId
def withProtocolFactory(protocolFactory: TProtocolFactory): Client

Annotations
@deprecated
Deprecated
(Since version 6.22.0) Use Thrift.client.withProtocolFactory

Related Doc: package finagle

object Thrift extends Client[ThriftClientRequest, Array[Byte]] with Server[Array[Byte], Array[Byte]]

Clients

Servers

Type Members

case class Server(stack: Stack[ServiceFactory[Array[Byte], Array[Byte]]] = Server.stack, params: Params = ...) extends StdStackServer[Array[Byte], Array[Byte], Server] with ThriftRichServer with Product with Serializable

case class ThriftImpl(transporter: (Params) ⇒ (SocketAddress) ⇒ Transporter[ThriftClientRequest, Array[Byte]], listener: (Params) ⇒ Listener[Array[Byte], Array[Byte]]) extends Product with Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Client extends Serializable

object Server extends Serializable

object ThriftImpl extends Serializable

final def asInstanceOf[T0]: T0

val client: Client

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

val maxThriftBufferSize: Int

final def ne(arg0: AnyRef): Boolean

def newClient(dest: Name, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

final def newClient(dest: String, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

final def newClient(dest: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

def newService(dest: Name, label: String): Service[ThriftClientRequest, Array[Byte]]

final def newService(dest: String, label: String): Service[ThriftClientRequest, Array[Byte]]

final def newService(dest: String): Service[ThriftClientRequest, Array[Byte]]

final def notify(): Unit

final def notifyAll(): Unit

object param

val protocolFactory: TProtocolFactory

def serve(addr: SocketAddress, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

def serve(addr: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

def serve(addr: String, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

def serve(addr: SocketAddress, service: Service[Array[Byte], Array[Byte]]): ListeningServer

def serveAndAnnounce(name: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

def serveAndAnnounce(name: String, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

def serveAndAnnounce(name: String, addr: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

def serveAndAnnounce(name: String, addr: String, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

def serveAndAnnounce(name: String, addr: SocketAddress, service: Service[Array[Byte], Array[Byte]]): ListeningServer

def serveAndAnnounce(name: String, addr: SocketAddress, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

val server: Server

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

final def newClient(dest: Group[SocketAddress]): ServiceFactory[ThriftClientRequest, Array[Byte]]

final def newService(dest: Group[SocketAddress]): Service[ThriftClientRequest, Array[Byte]]

def withClientId(clientId: ClientId): Client

def withProtocolFactory(protocolFactory: TProtocolFactory): Client

Inherited from finagle.Server[Array[Byte], Array[Byte]]

Inherited from finagle.Client[ThriftClientRequest, Array[Byte]]

Inherited from AnyRef

Inherited from Any

Ungrouped