Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type ThriftServiceType, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Creates a new StackClient with parameter psp._1 and Stack Param type psp._2.

Creates a new StackClient with parameter p.

Creates a new StackClient with additional parameters newParams.

A copy constructor in lieu of defining StackClient as a case class.

The client name used when group isn't named.

A stackable module that creates new Transports (via transporter) when applied.

Prepends filter to the top of the client. That is, after materializing the client (newClient/newService) filter will be the first element which requests flow through. This is a familiar chaining combinator for filters and is particularly useful for StdStackClient implementations that don't expose services but instead wrap the resulting service with a rich API.

Build client interfaces for multiplexed thrift services.

E.g.

val client = Thrift.client.multiplex(address, "client") { client =>
  new {
    val echo = client.newIface[Echo.MethodPerEndpoint]("echo")
    val extendedEcho = client.newServiceIface[ExtendedEcho.ServiceIface]("extendedEcho")
  }
}

client.echo.echo("hello")
client.extendedEcho.getStatus(ExtendedEcho.GetStatus.Args())

Build client interfaces for multiplexed thrift services.

E.g.

val client = Thrift.client.multiplex(address, "client") { client =>
  new {
    val echo = client.newIface[Echo.MethodPerEndpoint]("echo")
    val extendedEcho = client.newServiceIface[ExtendedEcho.ServiceIface]("extendedEcho")
  }
}

client.echo.echo("hello")
client.extendedEcho.getStatus(ExtendedEcho.GetStatus.Args())

Create a new client connected to dest. See the user guide for details on destination names.

Argument label is used to assign a label to this client. The label is used to display stats, etc.

Create a new client connected to dest. See the user guide for details on destination names.

Argument label is used to assign a label to this client. The label is used to display stats, etc.

Create a new client connected to dest. See the user guide for details on destination names.

Defines a dispatcher, a function which reconciles the stream based Transport with a Request/Response oriented Service. Together with a Transporter, it forms the foundation of a finagle client. Concrete implementations are expected to specify this.

Create a new service which dispatches requests to dest. See the user guide for details on destination names.

Argument label is used to assign a label to this client. The label is used to display stats, etc.

Create a new service which dispatches requests to dest. See the user guide for details on destination names.

Create a new service which dispatches requests to dest. See the user guide for details on destination names.

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: Logger.ServicePerEndpoint = Thrift.client.servicePerEndpoint[Logger.ServicePerEndpoint]("localhost:8000", "client_label")
val response: String = loggerService.log(Logger.Log.Args("log message", 1))

You can also create a Finagle Service[scrooge.Request, scrooge.Response] per-endpoint (method) 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 that uses the Scrooge Request/Response envelopes:

val loggerService: Logger.ReqRepServicePerEndpoint = Thrift.client.servicePerEndpoint[Logger.ReqRepServicePerEndpoint]("localhost:8000", "client_label")
val response: c.t.scrooge.Response[String] = loggerService.log(c.t.scrooge.Request(Logger.Log.Args("log message", 1)))

This allows you to access any contained c.t.scrooge.Request and c.t.scrooge.Response headers.

Defines a typed com.twitter.finagle.client.Transporter for this client. Concrete StackClient implementations are expected to specify this.

The current parameter map.

Export info about the transporter type so that we can query info about its implementation at runtime.

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: Logger.ServicePerEndpoint = Thrift.client.servicePerEndpoint[Logger.ServicePerEndpoint]("localhost:8000", "client_label")
val response: String = loggerService.log(Logger.Log.Args("log message", 1))

You can also create a Finagle Service[scrooge.Request, scrooge.Response] per-endpoint (method) 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 that uses the Scrooge Request/Response envelopes:

val loggerService: Logger.ReqRepServicePerEndpoint = Thrift.client.servicePerEndpoint[Logger.ReqRepServicePerEndpoint]("localhost:8000", "client_label")
val response: c.t.scrooge.Response[String] = loggerService.log(c.t.scrooge.Request(Logger.Log.Args("log message", 1)))

This allows you to access any contained c.t.scrooge.Request and c.t.scrooge.Response headers.

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: Logger.ServicePerEndpoint = Thrift.client.servicePerEndpoint[Logger.ServicePerEndpoint]("localhost:8000", "client_label")
val response: String = loggerService.log(Logger.Log.Args("log message", 1))

You can also create a Finagle Service[scrooge.Request, scrooge.Response] per-endpoint (method) 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 that uses the Scrooge Request/Response envelopes:

val loggerService: Logger.ReqRepServicePerEndpoint = Thrift.client.servicePerEndpoint[Logger.ReqRepServicePerEndpoint]("localhost:8000", "client_label")
val response: c.t.scrooge.Response[String] = loggerService.log(c.t.scrooge.Request(Logger.Log.Args("log message", 1)))

This allows you to access any contained c.t.scrooge.Request and c.t.scrooge.Response headers.

The current stack.

An entry point for configuring the clients' admission control

Use a buffered transport instead of the default framed transport. In almost all cases, the default framed transport should be used.

Configures this server or client with given exception stats handler.

Configures this server or client to shift user-defined computation (com.twitter.util.Future callbacks and transformations) off of IO threads into a given FuturePool.

By default, Finagle executes all futures in the IO threads, minimizing context switches. Given there is usually a fixed number of IO threads shared across a JVM process, it's critically important to ensure they aren't being blocked by the application code, affecting system's responsiveness. Shifting application-level work onto a dedicated FuturePool or ExecutorService offloads IO threads, which may improve throughput in CPU-bound systems.

As always, run your own tests before enabling this feature.

Configures this server or client to shift user-defined computation (com.twitter.util.Future callbacks and transformations) off of IO threads into a given ExecutorService.

By default, Finagle executes all futures in the IO threads, minimizing context switches. Given there is usually a fixed number of IO threads shared across a JVM process, it's critically important to ensure they aren't being blocked by the application code, affecting system's responsiveness. Shifting application-level work onto a dedicated FuturePool or ExecutorService offloads IO threads, which may improve throughput in CPU-bound systems.

As always, run your own tests before enabling this feature.

Configures this server or client with given label (default: empty string).

The label value is used for stats reporting to scope stats reported from different clients/servers to a single stats receiver.

An entry point for configuring the client's load balancer that implements a strategy for choosing one host/node from a replica set to service a request.

The default setup for a Finagle client is to use power of two choices algorithm to distribute load across endpoints, and comparing nodes via a least loaded metric.

Produce a com.twitter.finagle.Thrift.Client with the specified max size of the reusable buffer for thrift responses. If this size is exceeded, the buffer is not reused and a new buffer is allocated for the next thrift response. The default max size is 16Kb.

Configures this server or client with given util.Monitor (default: com.twitter.finagle.util.NullMonitor).

Monitors are Finagle's out-of-band exception reporters. Whenever an exception is thrown on a request path, it's reported to the monitor. The configured Monitor is composed (see below for how composition works) with the default monitor implementation, com.twitter.finagle.util.DefaultMonitor, which logs these exceptions.

Monitors are wired into the server or client stacks via com.twitter.finagle.filter.MonitorFilter and are applied to the following kinds of exceptions:

• Synchronous exceptions thrown on request path, Service.apply(request)
• Asynchronous exceptions (failed futures) thrown on request path, Service.apply(request)
• Exceptions thrown from respond, onSuccess, onFailure future callbacks
• Fatal exceptions thrown from map, flatMap, transform future continuations

Put it this way, we apply Monitor.handle to an exception if we would otherwise "lose" it, i.e. when it's not connected to the Future, nor is it connected to the call stack.

You can compose multiple monitors if you want to extend or override the standard behavior, defined in DefaultMonitor.

import com.twitter.util.Monitor

val consoleMonitor = new Monitor {
  def handle(exc: Throwable): Boolean = {
    Console.err.println(exc.toString)
    false // continue handling with the next monitor (usually DefaultMonitor)
   }
}

$.withMonitor(consoleMonitor)

Returning true form within a monitor effectively terminates the monitor chain so no exceptions are propagated down to the next monitor.

Creates a new StackClient with params used to configure this StackClient's stack.

An entry point for configuring Thrift/ThriftMux client's partitioning service

Configures the request timeout of this server or client (default: unbounded).

If the request has not completed within the given timeout, the pending work will be interrupted via com.twitter.util.Future.raise.

Client's Request Timeout

The client request timeout is the maximum amount of time given to a single request (if there are retries, they each get a fresh request timeout). The timeout is applied only after a connection has been acquired. That is: it is applied to the interval between the dispatch of the request and the receipt of the response.

Server's Request Timeout

The server request timeout is the maximum amount of time, a server is allowed to spend handling the incoming request. Using the Finagle terminology, this is an amount of time after which a non-satisfied future returned from the user-defined service times out.

Configures the Tunable request timeout of this server or client (if applying the Tunable produces a value of None, an unbounded timeout is used for the request).

If the request has not completed within the Duration resulting from timeout.apply(), the pending work will be interrupted via com.twitter.util.Future.raise.

Client's Request Timeout

The client request timeout is the maximum amount of time given to a single request (if there are retries, they each get a fresh request timeout). The timeout is applied only after a connection has been acquired. That is: it is applied to the interval between the dispatch of the request and the receipt of the response.

Server's Request Timeout

The server request timeout is the maximum amount of time, a server is allowed to spend handling the incoming request. Using the Finagle terminology, this is an amount of time after which a non-satisfied future returned from the user-defined service times out.

Configure a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.

This allows developers to give Finagle the additional application-specific knowledge necessary in order to properly classify responses. Without this, Finagle cannot make judgements about application-level failures as it only has a narrow understanding of failures (for example: transport level, timeouts, and nacks).

As an example take an HTTP server that returns a response with a 500 status code. To Finagle this is a successful request/response. However, the application developer may want to treat all 500 status codes as failures and can do so via setting a com.twitter.finagle.service.ResponseClassifier.

ResponseClassifier is a PartialFunction and as such multiple classifiers can be composed together via PartialFunction.orElse.

Response classification is independently configured on the client and server. For client-side response classification using com.twitter.finagle.builder.ClientBuilder, see com.twitter.finagle.builder.ClientBuilder.responseClassifier

Configures the requeue backoff policy of this client (default: no delay).

The policy encoded Backoff is used to calculate the next duration to delay each retry.

Configures the retry budget of this client (default: allows for about 20% of the total requests to be retried on top of 10 retries per second).

This budget is shared across requests and governs the number of retries that can be made by this client.

An entry point for configuring the client's session.

An entry point for configuring the client's session pool.

All session pool settings are applied to each host in the replica set. Put this way, these settings are per-host as opposed to per-client.

An entry point for configuring the client's session qualifiers (e.g. circuit breakers).

A new StackClient using the function to create a new Stack.

The input to fn is the client's current stack. This API allows for easier usage when writing code that uses method chaining.

This method is similar to transformed while providing easier API ergonomics for one-off Stack changes.

A new StackClient with the provided stack.

Configures this server or client with given stats.StatsReceiver (default: stats.DefaultStatsReceiver).

Produce a com.twitter.finagle.Thrift.Client with a factory creates new TReusableBuffer, the TReusableBuffer can be shared with other client instance. If set, the MaxReusableBufferSize will be ignored.

Configures this server or client with given tracing.Tracer (default: com.twitter.finagle.tracing.DefaultTracer).

An entry point for configuring the client's com.twitter.finagle.transport.Transport.

Transport is a Finagle abstraction over the network connection (i.e., a TCP connection).

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

Create a new client of type Iface, which must be generated by Scrooge.

For Scala generated code, the Class passed in should be either ServiceName$MethodPerEndpoint or ServiceName[Future].

For Java generated code, the Class passed in should be ServiceName$ServiceIface.

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: Logger.ServiceIface = Thrift.client.newServiceIface[Logger.ServiceIface]("localhost:8000", "client_label")
val response: String = loggerService.log(Logger.Log.Args("log message", 1))

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: Logger.ServiceIface = Thrift.client.newServiceIface[Logger.ServiceIface]("localhost:8000", "client_label")
val response: String = loggerService.log(Logger.Log.Args("log message", 1))

Creates a new StackClient with f applied to stack.

This is the same as withStack.