Thrift

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

Clients

For example, this IDL:

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

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

Thrift.newIface[TestService.FutureIface](
target, 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.newIface[TestService.FutureIface](target)

In Java, we need to provide the class object:

TestService.FutureIface client =
Thrift.newIface(target, 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.

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.

Servers

TestService.FutureIface must be implemented and passed into serveIface:

Thrift.serveIface(":*", new TestService.FutureIface {
  def query(x: String) = Future.value(x)  // (echo service)
})

Linear Supertypes

ThriftRichServer, ThriftRichClient, Server[Array[Byte], Array[Byte]], Client[ThriftClientRequest, Array[Byte]], AnyRef, Any

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws()
val defaultClientName: String

The client name used when group isn't named.
The client name used when group isn't named.

Attributes
protected
Definition Classes
Thrift → ThriftRichClient
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()
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
def newClient(group: Group[SocketAddress]): ServiceFactory[ThriftClientRequest, Array[Byte]]

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

Definition Classes
Client
def newIface[Iface](group: Group[SocketAddress])(implicit arg0: ClassManifest[Iface]): Iface

Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.
Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.

Definition Classes
ThriftRichClient
def newIface[Iface](target: String)(implicit arg0: ClassManifest[Iface]): Iface

Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.
Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.

Definition Classes
ThriftRichClient
def newIface[Iface](group: Group[SocketAddress], cls: Class[_]): Iface

Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.
Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.

Definition Classes
ThriftRichClient
def newIface[Iface](target: String, cls: Class[_]): Iface

Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.
Create a new client of type Iface, which must be generated by either Scrooge or thrift-finagle.

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

Definition Classes
Client
final def newService(group: Group[SocketAddress]): Service[ThriftClientRequest, Array[Byte]]

Definition Classes
Client
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val protocolFactory: Factory

Definition Classes
Thrift → ThriftRichServer → ThriftRichClient
def serve(addr: SocketAddress, service: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

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

Definition Classes
Server
def serve(target: 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, target: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

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

Definition Classes
Server
def serveIface(target: SocketAddress, iface: AnyRef): ListeningServer

$serveIface
$serveIface

Definition Classes
ThriftRichServer
def serveIface(target: String, iface: AnyRef): ListeningServer

Definition Classes
ThriftRichServer
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()
def withBufferedTransport(): ThriftImpl

Produce a com.twitter.finagle.ThriftImpl using a buffered transport.
Produce a com.twitter.finagle.ThriftImpl using a buffered transport.

Note
Not recommended. Use only if absolutely required for legacy purposes.
def withProtocolFactory(pf: TProtocolFactory): ThriftImpl

Produce a com.twitter.finagle.ThriftImpl using the given TProtocolFactory instead of the default binary protocol factory.

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

Clients

Servers

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val defaultClientName: String

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

final def ne(arg0: AnyRef): Boolean

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

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

def newIface[Iface](group: Group[SocketAddress])(implicit arg0: ClassManifest[Iface]): Iface

def newIface[Iface](target: String)(implicit arg0: ClassManifest[Iface]): Iface

def newIface[Iface](group: Group[SocketAddress], cls: Class[_]): Iface

def newIface[Iface](target: String, cls: Class[_]): Iface

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

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

final def notify(): Unit

final def notifyAll(): Unit

val protocolFactory: Factory

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

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

def serve(target: 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, target: String, service: Service[Array[Byte], Array[Byte]]): ListeningServer

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

def serveIface(target: SocketAddress, iface: AnyRef): ListeningServer

def serveIface(target: String, iface: AnyRef): ListeningServer

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

def withBufferedTransport(): ThriftImpl

def withProtocolFactory(pf: TProtocolFactory): ThriftImpl

Inherited from ThriftRichServer

Inherited from ThriftRichClient

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

Inherited from Client[ThriftClientRequest, Array[Byte]]

Inherited from AnyRef

Inherited from Any

Ungrouped