StdStackClient

Type Members

abstract type Context <: TransportContext

The type of the transport's context.
The type of the transport's context.

Attributes
protected
abstract type In

The type we write into the transport.
The type we write into the transport.

Attributes
protected
abstract type Out

The type we read out of the transport.
The type we read out of the transport.

Attributes
protected

Abstract Value Members

abstract def copy1(stack: Stack[ServiceFactory[Req, Rep]] = this.stack, params: Params = this.params): This { ... /* 2 definitions in type refinement */ }

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

Attributes
protected
Definition Classes
StdStackClient → EndpointerStackClient
abstract def newDispatcher(transport: Transport[In, Out] { type Context <: StdStackClient.this.Context }): Service[Req, Rep]

Defines a dispatcher, a function which reconciles the stream based Transport with a Request/Response oriented Service.
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.

Attributes
protected
See also
com.twitter.finagle.dispatch.GenSerialServerDispatcher
abstract def newTransporter(addr: SocketAddress): Transporter[In, Out, Context]

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

Attributes
protected
abstract def params: Params

The current parameter map.
The current parameter map.

Definition Classes
StackClient → Parameterized
abstract def stack: Stack[ServiceFactory[Req, Rep]]

The current stack.
The current stack.

Definition Classes
StackClient

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def configured[P](psp: (P, Param[P])): This

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

Definition Classes
EndpointerStackClient → StackClient → Parameterized
def configured[P](p: P)(implicit arg0: Param[P]): This

Creates a new StackClient with parameter p.
Creates a new StackClient with parameter p.

Definition Classes
EndpointerStackClient → StackClient → Parameterized
def configuredParams(newParams: Params): This

Creates a new StackClient with additional parameters newParams.
Creates a new StackClient with additional parameters newParams.

Definition Classes
EndpointerStackClient → StackClient → Parameterized
final def endpointer: Stackable[ServiceFactory[Req, Rep]]

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

Attributes
protected
Definition Classes
StdStackClient → EndpointerStackClient
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def filtered(filter: Filter[Req, Rep, Req, Rep]): This

Prepends filter to the top of the client.
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.

Definition Classes
EndpointerStackClient
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
def newClient(dest: Name, label0: String): ServiceFactory[Req, Rep]

Create a new client connected to dest.
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.
label0
if an empty String is provided, then the label from the Label Stack.Params is used. If that is also an empty String, then dest is used.

Definition Classes
EndpointerStackClient → Client
final def newClient(dest: String, label: String): ServiceFactory[Req, Rep]

Create a new client connected to dest.
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.

Definition Classes
Client
final def newClient(dest: String): ServiceFactory[Req, Rep]

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

Definition Classes
Client
def newService(dest: Name, label: String): Service[Req, Rep]

Create a new service which dispatches requests to dest.
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.

Definition Classes
EndpointerStackClient → Client
final def newService(dest: String, label: String): Service[Req, Rep]

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

Definition Classes
Client
final def newService(dest: String): Service[Req, Rep]

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

Definition Classes
Client
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def registerTransporter(transporterName: String): Unit

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

Attributes
protected
Definition Classes
StackClient
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def transformed(f: (Stack[ServiceFactory[Req, Rep]]) ⇒ Stack[ServiceFactory[Req, Rep]]): This

Creates a new StackClient with f applied to stack.
Creates a new StackClient with f applied to stack.
For expert users only.

Definition Classes
EndpointerStackClient
def transformed(t: Stack.Transformer): StackClient[Req, Rep]

Transform the stack using the given Transformer.
Transform the stack using the given Transformer.

Definition Classes
StackClient → Transformable
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( ... )
val withAdmissionControl: ClientAdmissionControlParams[This]

An entry point for configuring the clients' admission control
An entry point for configuring the clients' admission control

Definition Classes
WithClientAdmissionControl
def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): This

Configures this server or client with given exception stats handler.
Configures this server or client with given exception stats handler.

Definition Classes
CommonParams
def withLabel(label: String): This

Configures this server or client with given label (default: empty string).
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.

Definition Classes
CommonParams
def withMonitor(monitor: Monitor): This

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

Definition Classes
CommonParams
def withParams(params: Params): This

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

Definition Classes
EndpointerStackClient → StackClient → Parameterized
def withRequestTimeout(timeout: Tunable[Duration]): This

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

Definition Classes
CommonParams
See also
https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration and https://twitter.github.io/finagle/guide/Configuration.html#tunables
def withRequestTimeout(timeout: Duration): This

Configures the request timeout of this server or client (default: unbounded).
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.

Definition Classes
CommonParams
See also
https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration
def withResponseClassifier(responseClassifier: ResponseClassifier): This

Configure a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.
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

Definition Classes
CommonParams
Note
If unspecified, the default classifier is com.twitter.finagle.service.ResponseClassifier.Default which is a total function fully covering the input domain.
See also
com.twitter.finagle.http.service.HttpResponseClassifier for some HTTP classification tools.
def withRetryBackoff(backoff: Stream[Duration]): This

Configures the requeue backoff policy of this client (default: no delay).
Configures the requeue backoff policy of this client (default: no delay).
The backoff policy is represented by a stream of delays (i.e., Stream[Duration]) used to delay each retry.

Definition Classes
ClientParams
See also
https://twitter.github.io/finagle/guide/Clients.html#retries
def withRetryBudget(budget: RetryBudget): This

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

Definition Classes
ClientParams
Note
The retry budget helps prevent clients from overwhelming the downstream service.
See also
https://twitter.github.io/finagle/guide/Clients.html#retries
val withSession: ClientSessionParams[This]

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

Definition Classes
WithClientSession
val withSessionQualifier: SessionQualificationParams[This]

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

Definition Classes
WithSessionQualifier
See also
https://twitter.github.io/finagle/guide/Clients.html#circuit-breaking
def withStack(stack: Stack[ServiceFactory[Req, Rep]]): This

A new StackClient with the provided stack.
A new StackClient with the provided stack.

Definition Classes
EndpointerStackClient → StackClient
def withStatsReceiver(statsReceiver: StatsReceiver): This

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

Definition Classes
CommonParams
def withTracer(tracer: Tracer): This

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

Definition Classes
CommonParams
val withTransport: ClientTransportParams[This]

An entry point for configuring the client's com.twitter.finagle.transport.Transport.
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).

Definition Classes
WithClientTransport

Related Doc: package client

trait StdStackClient[Req, Rep, This <: StdStackClient[Req, Rep, This]] extends EndpointerStackClient[Req, Rep, This]

Type Members

abstract type Context <: TransportContext

abstract type In

abstract type Out

Abstract Value Members

abstract def copy1(stack: Stack[ServiceFactory[Req, Rep]] = this.stack, params: Params = this.params): This { ... /* 2 definitions in type refinement */ }

abstract def newDispatcher(transport: Transport[In, Out] { type Context <: StdStackClient.this.Context }): Service[Req, Rep]

abstract def newTransporter(addr: SocketAddress): Transporter[In, Out, Context]

abstract def params: Params

abstract def stack: Stack[ServiceFactory[Req, Rep]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def configured[P](psp: (P, Param[P])): This

def configured[P](p: P)(implicit arg0: Param[P]): This

def configuredParams(newParams: Params): This

final def endpointer: Stackable[ServiceFactory[Req, Rep]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def filtered(filter: Filter[Req, Rep, Req, Rep]): This

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newClient(dest: Name, label0: String): ServiceFactory[Req, Rep]

final def newClient(dest: String, label: String): ServiceFactory[Req, Rep]

final def newClient(dest: String): ServiceFactory[Req, Rep]

def newService(dest: Name, label: String): Service[Req, Rep]

final def newService(dest: String, label: String): Service[Req, Rep]

final def newService(dest: String): Service[Req, Rep]

final def notify(): Unit

final def notifyAll(): Unit

final def registerTransporter(transporterName: String): Unit

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

def toString(): String

def transformed(f: (Stack[ServiceFactory[Req, Rep]]) ⇒ Stack[ServiceFactory[Req, Rep]]): This

def transformed(t: Stack.Transformer): StackClient[Req, Rep]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val withAdmissionControl: ClientAdmissionControlParams[This]

def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): This

def withLabel(label: String): This

def withMonitor(monitor: Monitor): This

def withParams(params: Params): This

def withRequestTimeout(timeout: Tunable[Duration]): This

Client's Request Timeout

Server's Request Timeout

def withRequestTimeout(timeout: Duration): This

Client's Request Timeout

Server's Request Timeout

def withResponseClassifier(responseClassifier: ResponseClassifier): This

def withRetryBackoff(backoff: Stream[Duration]): This

def withRetryBudget(budget: RetryBudget): This

val withSession: ClientSessionParams[This]

val withSessionQualifier: SessionQualificationParams[This]

def withStack(stack: Stack[ServiceFactory[Req, Rep]]): This

def withStatsReceiver(statsReceiver: StatsReceiver): This

def withTracer(tracer: Tracer): This

val withTransport: ClientTransportParams[This]

Inherited from EndpointerStackClient[Req, Rep, This]

Inherited from WithSessionQualifier[This]

Inherited from WithClientSession[This]

Inherited from WithClientTransport[This]

Inherited from WithClientAdmissionControl[This]

Inherited from ClientParams[This]

Inherited from CommonParams[This]

Inherited from StackClient[Req, Rep]

Inherited from StackBasedClient[Req, Rep]

Inherited from Transformable[StackClient[Req, Rep]]

Inherited from Parameterized[This]

Inherited from Client[Req, Rep]

Inherited from AnyRef