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 https://github.com/twitter/finagle/blob/master/finagle-thrift/src/main/thrift/tracing.thrift here.

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

In Java, we need to provide the class object:

TestService.FutureIface client =
Thrift.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:

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

Linear Supertypes

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

Type Members

case class Client(stack: Stack[ServiceFactory[ThriftClientRequest, Array[Byte]]] = Thrift.this.Client.stack, params: Params = ..., framed: Boolean = true) extends StdStackClient[ThriftClientRequest, Array[Byte], Client] with ThriftRichClient with Product with Serializable
case class Server(stack: Stack[ServiceFactory[Array[Byte], Array[Byte]]] = Thrift.this.Server.stack, params: Params = ..., framed: Boolean = true) extends StdStackServer[Array[Byte], Array[Byte], Server] with ThriftRichServer with Product with Serializable

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
object Client extends Serializable
object Server 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( ... )
lazy val defaultClientName: String

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

Definition Classes
ThriftRichServer
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 newIface[Iface](name: Name, label: 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
def newIface[Iface](dest: Name, label: String)(implicit arg0: ClassTag[Iface]): Iface

Definition Classes
ThriftRichClient
def newIface[Iface](dest: String, label: String)(implicit arg0: ClassTag[Iface]): Iface

Definition Classes
ThriftRichClient
def newIface[Iface](dest: String)(implicit arg0: ClassTag[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](dest: String, label: 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
def newIface[Iface](dest: 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
def newMethodIface[ServiceIface, FutureIface](serviceIface: ServiceIface)(implicit builder: MethodIfaceBuilder[ServiceIface, FutureIface]): FutureIface

Definition Classes
ThriftRichClient
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
def newServiceIface[ServiceIface](dest: Name)(implicit builder: ServiceIfaceBuilder[ServiceIface]): ServiceIface

Definition Classes
ThriftRichClient
def newServiceIface[ServiceIface](dest: String)(implicit builder: ServiceIfaceBuilder[ServiceIface]): ServiceIface

Construct a Finagle Service interface for a Scrooge-generated thrift object.
Construct a Finagle Service interface for a Scrooge-generated thrift object.
E.g. given a thrift service
```
service Logger {
string log(1: string message, 2: i32 logLevel);
i32 getLogSize();
}
```
you can construct a client interface with a Finagle Service per thrift method:
```
val loggerService = Thrift.newServiceIface(Logger, "localhost:8000")
val response = loggerService.log(Logger.Log.Args("log message", 1))
```
dest
Address of the service to connect to, in the format accepted by Resolver.eval.
builder
The builder type is generated by Scrooge for a thrift service.

Definition Classes
ThriftRichClient
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
object param
val protocolFactory: TProtocolFactory

Definition Classes
Thrift → ThriftRichServer → ThriftRichClient
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 serveIface(addr: SocketAddress, iface: AnyRef): ListeningServer

Serve the interface implementation iface, which must be generated by either Scrooge or thrift-finagle.
Serve the interface implementation iface, which must be generated by either Scrooge or thrift-finagle.
Given the IDL:
```
service TestService {
string query(1: string x)
}
```
Scrooge will generate an interface, TestService.FutureIface, implementing the above IDL.
TestService.FutureIface must be implemented and passed into serveIface:
```
Thrift.serveIface(":*", new TestService.FutureIface {
  def query(x: String) = Future.value(x)  // (echo service)
})
```
Note that this interface is discovered by reflection. Passing an invalid interface implementation will result in a runtime error.
Definition Classes
ThriftRichServer
def serveIface(addr: String, iface: AnyRef): ListeningServer

Serve the interface implementation iface, which must be generated by either Scrooge or thrift-finagle.
Serve the interface implementation iface, which must be generated by either Scrooge or thrift-finagle.
Given the IDL:
```
service TestService {
string query(1: string x)
}
```
Scrooge will generate an interface, TestService.FutureIface, implementing the above IDL.
TestService.FutureIface must be implemented and passed into serveIface:
```
Thrift.serveIface(":*", new TestService.FutureIface {
  def query(x: String) = Future.value(x)  // (echo service)
})
```
Note that this interface is discovered by reflection. Passing an invalid interface implementation will result in a runtime error.
Definition Classes
ThriftRichServer
val server: Server
val serverLabel: String

Attributes
protected
Definition Classes
ThriftRichServer
lazy val serverStats: StatsReceiver

Attributes
protected
Definition Classes
ThriftRichServer
lazy val stats: StatsReceiver

Attributes
protected
Definition Classes
Thrift → ThriftRichClient
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
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
Annotations
@deprecated
Deprecated
(Since version 6.7.x) Use destination names via newIface(String) or newIface(Name)
def newIface[Iface](group: Group[SocketAddress])(implicit arg0: ClassTag[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
Annotations
@deprecated
Deprecated
(Since version 6.7.x) Use destination names via newIface(String) or newIface(Name)
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

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

Clients

Servers

Type Members

case class Client(stack: Stack[ServiceFactory[ThriftClientRequest, Array[Byte]]] = Thrift.this.Client.stack, params: Params = ..., framed: Boolean = true) extends StdStackClient[ThriftClientRequest, Array[Byte], Client] with ThriftRichClient with Product with Serializable

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

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

object Client extends Serializable

object Server extends Serializable

final def asInstanceOf[T0]: T0

val client: Client

def clone(): AnyRef

lazy 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

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 newIface[Iface](name: Name, label: String, cls: Class[_]): Iface

def newIface[Iface](dest: Name, label: String)(implicit arg0: ClassTag[Iface]): Iface

def newIface[Iface](dest: String, label: String)(implicit arg0: ClassTag[Iface]): Iface

def newIface[Iface](dest: String)(implicit arg0: ClassTag[Iface]): Iface

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

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

def newMethodIface[ServiceIface, FutureIface](serviceIface: ServiceIface)(implicit builder: MethodIfaceBuilder[ServiceIface, FutureIface]): FutureIface

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

def newServiceIface[ServiceIface](dest: Name)(implicit builder: ServiceIfaceBuilder[ServiceIface]): ServiceIface

def newServiceIface[ServiceIface](dest: String)(implicit builder: ServiceIfaceBuilder[ServiceIface]): ServiceIface

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 serveIface(addr: SocketAddress, iface: AnyRef): ListeningServer

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

val server: Server

val serverLabel: String

lazy val serverStats: StatsReceiver

lazy val stats: StatsReceiver

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

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

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

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

def withClientId(clientId: ClientId): Client

def withProtocolFactory(protocolFactory: TProtocolFactory): Client

Inherited from ThriftRichServer

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

Inherited from ThriftRichClient

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

Inherited from AnyRef

Inherited from Any

Ungrouped