ThriftMethodBuilderClientModule

Instance Constructors

new ThriftMethodBuilderClientModule()(implicit servicePerEndpointBuilder: ServicePerEndpointBuilder[ServicePerEndpoint], methodPerEndpointBuilder: MethodPerEndpointBuilder[ServicePerEndpoint, MethodPerEndpoint])

Abstract Value Members

abstract def dest: String

Destination of ThriftMux client.
Destination of ThriftMux client.

Definition Classes
ThriftClientModuleTrait
See also
Names and Naming in Finagle
abstract def label: String

ThriftMux client label.
ThriftMux client label.

Definition Classes
ThriftClientModuleTrait
See also
Clients Observability

Concrete 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 addError(arg0: Message): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def addError(arg0: Throwable): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def addError(arg0: String, arg1: <repeated...>[AnyRef]): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def addTypeConverter[T](converter: TypeConverter)(implicit arg0: Manifest[T]): Unit

Attributes
protected
Definition Classes
TwitterModule
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bind[T, A <: Annotation](implicit arg0: Manifest[T], arg1: Manifest[A]): ScalaAnnotatedBindingBuilder[T]

Attributes
protected
Definition Classes
TwitterModule
def bind[T](annotation: Annotation)(implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

Attributes
protected
Definition Classes
TwitterModule
def bind[T](implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

Attributes
protected
Definition Classes
TwitterModule
def bind[T](arg0: Class[T]): AnnotatedBindingBuilder[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bind[T](arg0: TypeLiteral[T]): AnnotatedBindingBuilder[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bind[T](arg0: Key[T]): LinkedBindingBuilder[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bindAssistedFactory[T]()(implicit arg0: Manifest[T]): Unit

Attributes
protected
Definition Classes
TwitterModule
def bindConstant(): AnnotatedConstantBindingBuilder

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bindInterceptor(arg0: Matcher[_ >: Class[_]], arg1: Matcher[_ >: Method], arg2: <repeated...>[MethodInterceptor]): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bindListener(arg0: Matcher[_ >: Binding[_]], arg1: <repeated...>[ProvisionListener]): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bindListener(arg0: Matcher[_ >: TypeLiteral[_]], arg1: TypeListener): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bindScope(arg0: Class[_ <: Annotation], arg1: Scope): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def bindSingleton[T, A <: Annotation](implicit arg0: Manifest[T], arg1: Manifest[A]): ScalaAnnotatedBindingBuilder[T]

Attributes
protected
Definition Classes
TwitterModule
def bindSingleton[T](annotation: Annotation)(implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

Attributes
protected
Definition Classes
TwitterModule
def bindSingleton[T](implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

Attributes
protected
Definition Classes
TwitterModule
def binder(): Binder

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def configure(): Unit

Attributes
protected
Definition Classes
TwitterModule → AbstractModule
final def configure(arg0: Binder): Unit

Definition Classes
AbstractModule → Module
def configureMethodBuilder(methodBuilder: MethodBuilder): MethodBuilder

This method allows for extended configuration of the base MethodBuilder (e.g., the MethodBuilder used as a starting point for all method configurations) not exposed by this module or for overriding provided defaults, e.g.,
This method allows for extended configuration of the base MethodBuilder (e.g., the MethodBuilder used as a starting point for all method configurations) not exposed by this module or for overriding provided defaults, e.g.,
```
override def configureMethodBuilder(methodBuilder: thriftmux.MethodBuilder): thriftmux.MethodBuilder = {
  methodBuilder
    .withTimeoutTotal(5.seconds)
}
```
Note: any configuration here will be applied to all methods unless explicitly overridden. However, also note that filters are cumulative. Thus filters added here will be present in any final configuration.
methodBuilder
the thriftmux.MethodBuilder to configure.
returns
a configured MethodBuilder which will be used as the starting point for any per-method configuration.

Attributes
protected
def configureServicePerEndpoint(builder: ThriftMethodBuilderFactory[ServicePerEndpoint], servicePerEndpoint: ServicePerEndpoint): ServicePerEndpoint

Configure the ServicePerEndpoint.
Configure the ServicePerEndpoint. This is done by using the given ThriftMethodBuilderFactory to configure a com.twitter.inject.thrift.ThriftMethodBuilder for a given ThriftMethod. E.g.,
servicePerEndpoint .withFetchBlob( builder.method(FetchBlob) ...
Subclasses of this module MAY provide an implementation of configureServicePerEndpoint which specifies configuration of a ServicePerEndpoint interface per-method of the interface.
builder
a ThriftMethodBuilderFactory for creating a com.twitter.inject.thrift.ThriftMethodBuilder.
servicePerEndpoint
the ServicePerEndpoint to configure.
returns
a per-method filtered ServicePerEndpoint

Attributes
protected
See also
com.twitter.inject.thrift.ThriftMethodBuilder
def configureThriftMuxClient(client: Client): Client

This method allows for further configuration of the ThriftMux client for parameters not exposed by this module or for overriding defaults provided herein, e.g.,
This method allows for further configuration of the ThriftMux client for parameters not exposed by this module or for overriding defaults provided herein, e.g.,
```
override def configureThriftMuxClient(client: ThriftMux.Client): ThriftMux.Client = {
  client
    .withProtocolFactory(myCustomProtocolFactory))
    .withStatsReceiver(someOtherScopedStatsReceiver)
    .withMonitor(myAwesomeMonitor)
    .withTracer(notTheDefaultTracer)
    .withResponseClassifier(ThriftResponseClassifier.ThriftExceptionsAsFailures)
}
```
client
the com.twitter.finagle.ThriftMux.Client to configure.
returns
a configured ThriftMux.Client.

Attributes
protected
Definition Classes
ThriftMethodBuilderClientModule → ThriftClientModuleTrait
def convertToTypes(arg0: Matcher[_ >: TypeLiteral[_]], arg1: TypeConverter): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def createKey[T](implicit arg0: Manifest[T]): Key[T]

Attributes
protected
Definition Classes
TwitterBaseModule
def createMultiBinder[MultiBindType](implicit arg0: Manifest[MultiBindType]): ScalaMultibinder[MultiBindType]

Attributes
protected
Definition Classes
TwitterModule
def currentStage(): Stage

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def debug(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

Attributes
protected
Definition Classes
Logging
def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def error(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def flag[T](name: String, help: String)(implicit arg0: Flaggable[T], arg1: Manifest[T]): Flag[T]

Attributes
protected
Definition Classes
TwitterModuleFlags
def flag[T](name: String, default: T, help: String)(implicit arg0: Flaggable[T]): Flag[T]

Attributes
protected
Definition Classes
TwitterModuleFlags
val flags: ArrayBuffer[Flag[_]]

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleFlags
def frameworkModules: Seq[Module]

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterBaseModule
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getMembersInjector[T](arg0: TypeLiteral[T]): MembersInjector[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def getMembersInjector[T](arg0: Class[T]): MembersInjector[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def getProvider[T](implicit arg0: Manifest[T]): Provider[T]

Attributes
protected
Definition Classes
TwitterModule
def getProvider[T](arg0: Class[T]): Provider[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def getProvider[T](arg0: Key[T]): Provider[T]

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def hashCode(): Int

Definition Classes
AnyRef → Any
def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def info(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
def install(module: Module): Unit

Attributes
protected
Definition Classes
TwitterModule → AbstractModule
def isDebugEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isDebugEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isErrorEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isInfoEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isTraceEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isTraceEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled(marker: Marker): Boolean

Attributes
protected[this]
Definition Classes
Logging
def isWarnEnabled: Boolean

Attributes
protected[this]
Definition Classes
Logging
def logger: Logger

Attributes
protected[this]
Definition Classes
Logging
def loggerName: String

Attributes
protected
Definition Classes
Logging
def modules: Seq[Module]

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterBaseModule
def monitor: Monitor

Function to add a user-defined Monitor.
Function to add a user-defined Monitor. A com.twitter.finagle.util.DefaultMonitor will be installed implicitly which handles all exceptions caught in the stack. Exceptions that are not handled by a user-defined monitor are propagated to the com.twitter.finagle.util.DefaultMonitor.
NullMonitor has no influence on DefaultMonitor behavior here.

Attributes
protected
Definition Classes
ThriftMethodBuilderClientModule → ThriftClientModuleTrait
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def providesMethodPerEndpoint(servicePerEndpoint: ServicePerEndpoint): MethodPerEndpoint

Annotations
@Provides() @Singleton()
final def providesServicePerEndpoint(injector: Injector, clientId: ClientId, statsReceiver: StatsReceiver): ServicePerEndpoint

Annotations
@Provides() @Singleton()
def requestInjection(arg0: Any): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def requestStaticInjection(arg0: <repeated...>[Class[_]]): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def requestTimeout: Duration

Configures a "global" request timeout on the ThriftMux client (default: unbounded).
Configures a "global" request timeout on the ThriftMux client (default: unbounded). This will set *all* requests to *every* method to have the same total timeout.
returns
a Duration which represents the total request timeout

Attributes
protected
Definition Classes
ThriftMethodBuilderClientModule → ThriftClientModuleTrait
See also
https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration
com.twitter.finagle.param.CommonParams.withRequestTimeout
def requireBinding(arg0: Class[_]): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def requireBinding(arg0: Key[_]): Unit

Attributes
protected[com.google.inject]
Definition Classes
AbstractModule
def retryBudget: Budget

Default com.twitter.finagle.service.RetryBudget.
Default com.twitter.finagle.service.RetryBudget. It is highly recommended that budgets be shared between all filters that retry or re-queue requests to prevent retry storms.
returns
a default com.twitter.finagle.service.RetryBudget

Attributes
protected
Definition Classes
ThriftMethodBuilderClientModule → ThriftClientModuleTrait
See also
https://twitter.github.io/finagle/guide/Clients.html#retries
def sessionAcquisitionTimeout: Duration

Configures the session acquisition timeout of this client (default: unbounded).
Configures the session acquisition timeout of this client (default: unbounded).
returns
a Duration which represents the acquisition timeout

Attributes
protected
Definition Classes
ThriftMethodBuilderClientModule → ThriftClientModuleTrait
See also
https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration
com.twitter.finagle.param.ClientSessionParams.acquisitionTimeout
def singletonPostWarmupComplete(injector: Injector): Unit

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleLifecycle
def singletonShutdown(injector: Injector): Unit

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleLifecycle
def singletonStartup(injector: Injector): Unit

Attributes
protected[com.twitter.inject]
Definition Classes
TwitterModuleLifecycle
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def time[T](formatStr: String)(func: ⇒ T): T

Attributes
protected
Definition Classes
Logging
def toString(): String

Definition Classes
AnyRef → Any
def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def trace(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def traceResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging
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 warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(message: ⇒ Any, cause: Throwable): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(marker: Marker, message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def warn(message: ⇒ Any): Unit

Attributes
protected[this]
Definition Classes
Logging
def warnResult[T](message: ⇒ String)(fn: ⇒ T): T

Attributes
protected[this]
Definition Classes
Logging

Related Doc: package modules

abstract class ThriftMethodBuilderClientModule[ServicePerEndpoint <: Filterable[ServicePerEndpoint], MethodPerEndpoint] extends TwitterModule with ThriftClientModuleTrait

Instance Constructors

new ThriftMethodBuilderClientModule()(implicit servicePerEndpointBuilder: ServicePerEndpointBuilder[ServicePerEndpoint], methodPerEndpointBuilder: MethodPerEndpointBuilder[ServicePerEndpoint, MethodPerEndpoint])

Abstract Value Members

abstract def dest: String

abstract def label: String

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addError(arg0: Message): Unit

def addError(arg0: Throwable): Unit

def addError(arg0: String, arg1: <repeated...>[AnyRef]): Unit

def addTypeConverter[T](converter: TypeConverter)(implicit arg0: Manifest[T]): Unit

final def asInstanceOf[T0]: T0

def bind[T, A <: Annotation](implicit arg0: Manifest[T], arg1: Manifest[A]): ScalaAnnotatedBindingBuilder[T]

def bind[T](annotation: Annotation)(implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

def bind[T](implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

def bind[T](arg0: Class[T]): AnnotatedBindingBuilder[T]

def bind[T](arg0: TypeLiteral[T]): AnnotatedBindingBuilder[T]

def bind[T](arg0: Key[T]): LinkedBindingBuilder[T]

def bindAssistedFactory[T]()(implicit arg0: Manifest[T]): Unit

def bindConstant(): AnnotatedConstantBindingBuilder

def bindInterceptor(arg0: Matcher[_ >: Class[_]], arg1: Matcher[_ >: Method], arg2: <repeated...>[MethodInterceptor]): Unit

def bindListener(arg0: Matcher[_ >: Binding[_]], arg1: <repeated...>[ProvisionListener]): Unit

def bindListener(arg0: Matcher[_ >: TypeLiteral[_]], arg1: TypeListener): Unit

def bindScope(arg0: Class[_ <: Annotation], arg1: Scope): Unit

def bindSingleton[T, A <: Annotation](implicit arg0: Manifest[T], arg1: Manifest[A]): ScalaAnnotatedBindingBuilder[T]

def bindSingleton[T](annotation: Annotation)(implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

def bindSingleton[T](implicit arg0: Manifest[T]): ScalaAnnotatedBindingBuilder[T]

def binder(): Binder

def clone(): AnyRef

def configure(): Unit

final def configure(arg0: Binder): Unit

def configureMethodBuilder(methodBuilder: MethodBuilder): MethodBuilder

def configureServicePerEndpoint(builder: ThriftMethodBuilderFactory[ServicePerEndpoint], servicePerEndpoint: ServicePerEndpoint): ServicePerEndpoint

def configureThriftMuxClient(client: Client): Client

def convertToTypes(arg0: Matcher[_ >: TypeLiteral[_]], arg1: TypeConverter): Unit

def createKey[T](implicit arg0: Manifest[T]): Key[T]

def createMultiBinder[MultiBindType](implicit arg0: Manifest[MultiBindType]): ScalaMultibinder[MultiBindType]

def currentStage(): Stage

def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def debug(message: ⇒ Any, cause: Throwable): Unit

def debug(marker: Marker, message: ⇒ Any): Unit

def debug(message: ⇒ Any): Unit

def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def error(marker: Marker, message: ⇒ Any): Unit

def error(message: ⇒ Any, cause: Throwable): Unit

def error(message: ⇒ Any): Unit

def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

def finalize(): Unit

def flag[T](name: String, help: String)(implicit arg0: Flaggable[T], arg1: Manifest[T]): Flag[T]

def flag[T](name: String, default: T, help: String)(implicit arg0: Flaggable[T]): Flag[T]

val flags: ArrayBuffer[Flag[_]]

def frameworkModules: Seq[Module]

final def getClass(): Class[_]

def getMembersInjector[T](arg0: TypeLiteral[T]): MembersInjector[T]

def getMembersInjector[T](arg0: Class[T]): MembersInjector[T]

def getProvider[T](implicit arg0: Manifest[T]): Provider[T]

def getProvider[T](arg0: Class[T]): Provider[T]

def getProvider[T](arg0: Key[T]): Provider[T]

def hashCode(): Int

def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

def info(message: ⇒ Any, cause: Throwable): Unit

def info(marker: Marker, message: ⇒ Any): Unit

def info(message: ⇒ Any): Unit

def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

def install(module: Module): Unit

def isDebugEnabled(marker: Marker): Boolean

def isDebugEnabled: Boolean

def isErrorEnabled(marker: Marker): Boolean

def isErrorEnabled: Boolean

def isInfoEnabled(marker: Marker): Boolean

def isInfoEnabled: Boolean