ThriftMux

The ThriftMux object is both a com.twitter.finagle.Client and a com.twitter.finagle.Server for the Thrift protocol served over com.twitter.finagle.mux. Rich interfaces are provided to adhere to those generated from a Thrift IDL by Scrooge or thrift-finagle.

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 ThriftMux.Client.newIface:

ThriftMux.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:

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

In Java, we need to provide the class object:

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

Servers

Servers are also simple to expose:

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)
})

This object does not expose any configuration options. Both clients and servers are instantiated with sane defaults. Clients are labeled with the "clnt/thrift" prefix and servers with "srv/thrift". If you'd like more configuration, see the configuration documentation.

Linear Supertypes

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

Type Members

case class Client(muxer: StackClient[Request, Response] = Client.standardMuxer) extends StackBasedClient[ThriftClientRequest, Array[Byte]] with Parameterized[Client] with Transformable[Client] with CommonParams[Client] with ClientParams[Client] with WithClientTransport[Client] with WithClientAdmissionControl[Client] with WithClientSession[Client] with WithSessionQualifier[Client] with WithDefaultLoadBalancer[Client] with ThriftRichClient with OpportunisticTlsParams[Client] with WithCompressionPreferences[Client] with Product with Serializable

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

See also
Mux documentation
Thrift documentation
Configuration documentation
final case class Server(muxer: StackServer[Request, Response] = Server.defaultMuxer) extends StackBasedServer[Array[Byte], Array[Byte]] with ThriftRichServer with Parameterized[Server] with CommonParams[Server] with WithServerTransport[Server] with WithServerSession[Server] with WithServerAdmissionControl[Server] with OpportunisticTlsParams[Server] with WithCompressionPreferences[Server] with Product with Serializable

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

See also
Mux documentation
Thrift documentation
Configuration documentation

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
val BaseClientStack: Stack[ServiceFactory[Request, Response]]

Base com.twitter.finagle.Stack for ThriftMux clients.
val BaseServerParams: Params

Base com.twitter.finagle.Stack.Params for ThriftMux servers.
val BaseServerStack: Stack[ServiceFactory[Request, Response]]

Base com.twitter.finagle.Stack for ThriftMux servers.
object Client extends ThriftClient with Serializable
object Server extends Serializable
final def asInstanceOf[T0]: T0

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

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

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

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

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

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

Definition Classes
ThriftMux → 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
ThriftMux → 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
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
val protocolFactory: TProtocolFactory

Attributes
protected
def serve(addr: SocketAddress, factory: ServiceFactory[Array[Byte], Array[Byte]]): ListeningServer

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

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

Definition Classes
Server
final 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
def server: Server
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package finagle

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

Clients

Servers

Type Members

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val BaseClientStack: Stack[ServiceFactory[Request, Response]]

val BaseServerParams: Params

val BaseServerStack: Stack[ServiceFactory[Request, Response]]

object Client extends ThriftClient with Serializable

object Server extends Serializable

final def asInstanceOf[T0]: T0

def client: Client

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

val protocolFactory: TProtocolFactory

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

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

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

final 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

def server: Server

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

def toString(): String

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

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped