ThriftServiceIface

Construct Service interface for a Thrift method.

There are two ways to use a Scrooge-generated Thrift Service with Finagle:

1. Using a Service interface, i.e. a collection of Finagle Services.

2. Using a method interface, i.e. a collection of methods returning Futures.

Example: for a Thrift service IDL:

service Logger {
  string log(1: string message, 2: i32 logLevel);
  i32 getLogSize();
}

the Service interface, or ServiceIface, is

trait LoggerServiceIface {
  val log: com.twitter.finagle.Service[Logger.Log.Args, Logger.Log.SuccessType]
  val getLogSize: com.twitter.finagle.Service[Logger.GetLogSize.Args, Logger.GetLogSize.SuccessType]
}

and the method interface, or MethodIface, is

trait Logger[Future] {
  def log(message: String, logLevel: Int): Future[String]
  def getLogSize(): Future[Int]
}

Service interfaces can be modified and composed with Finagle Filters.

Linear Supertypes

AnyRef, Any

Type Members

type Filterable[+T] = service.Filterable[T]

Annotations
@deprecated
Deprecated
(Since version 2017-11-06) Use com.twitter.finagle.thrift.service.Filterable

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
def apply(method: ThriftMethod, thriftService: Service[ThriftClientRequest, Array[Byte]], pf: TProtocolFactory, stats: StatsReceiver): Service[Args, SuccessType]
def apply(method: ThriftMethod, thriftService: Service[ThriftClientRequest, Array[Byte]], clientParam: RichClientParam): Service[Args, SuccessType]

Build a Service from a given Thrift method.
final def asInstanceOf[T0]: T0

Definition Classes
Any
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def resultFilter(method: ThriftMethod): Filter[Args, SuccessType, Args, Result]
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

def apply(method: ThriftMethod, thriftService: Service[ThriftClientRequest, Array[Byte]], pf: TProtocolFactory, stats: StatsReceiver, responseClassifier: ResponseClassifier): Service[Args, SuccessType]

Annotations
@deprecated
Deprecated
(Since version 2017-08-16) Use com.twitter.finagle.thrift.RichClientParam

Related Doc: package thrift

object ThriftServiceIface

Type Members

type Filterable[+T] = service.Filterable[T]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply(method: ThriftMethod, thriftService: Service[ThriftClientRequest, Array[Byte]], pf: TProtocolFactory, stats: StatsReceiver): Service[Args, SuccessType]

def apply(method: ThriftMethod, thriftService: Service[ThriftClientRequest, Array[Byte]], clientParam: RichClientParam): Service[Args, SuccessType]

final def asInstanceOf[T0]: T0

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def resultFilter(method: ThriftMethod): Filter[Args, SuccessType, Args, Result]

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

def apply(method: ThriftMethod, thriftService: Service[ThriftClientRequest, Array[Byte]], pf: TProtocolFactory, stats: StatsReceiver, responseClassifier: ResponseClassifier): Service[Args, SuccessType]

Inherited from AnyRef

Inherited from Any

Ungrouped