package builder
- Alphabetic
- Public
- Protected
Type Members
- class ClientBuilder[Req, Rep, HasCluster, HasCodec, HasHostConnectionLimit] extends AnyRef
A builder of Finagle Clients.
A builder of Finagle Clients.
Please see the user guide for information on the preferred
with-style and MethodBuilder client-construction APIs.val client = ClientBuilder() .stack(Http.client) .hosts("localhost:10000,localhost:10001,localhost:10003") .hostConnectionLimit(1) .tcpConnectTimeout(1.second) // max time to spend establishing a TCP connection. .retries(2) // (1) per-request retries .reportTo(DefaultStatsReceiver) // export host-level load data to the loaded-StatsReceiver .build()
The
ClientBuilderrequires the definition ofcluster,stack, andhostConnectionLimit. In Scala, these are statically type checked, and in Java the lack of any of the above causes a runtime error.The
buildmethod uses an implicit argument to statically typecheck the builder (to ensure completeness, see above). The Java compiler cannot provide such implicit, so we provide a separate function in Java to accomplish this. Thus, the Java code for the above isService<HttpRequest, HttpResponse> service = ClientBuilder.safeBuild( ClientBuilder.get() .stack(Http.client()) .hosts("localhost:10000,localhost:10001,localhost:10003") .hostConnectionLimit(1) .tcpConnectTimeout(1.second) .retries(2) .reportTo(DefaultStatsReceiver)Alternatively, using the
unsafeBuildmethod onClientBuilderverifies the builder dynamically, resulting in a runtime error instead of a compiler error.Defaults
The following defaults are applied to clients constructed via ClientBuilder, unless overridden with the corresponding method. These defaults were chosen carefully so as to work well for most use cases.
Commonly-configured options:
connectTimeout: Duration.ToptcpConnectTimeout: 1 secondrequestTimeout: Duration.Toptimeout: Duration.TophostConnectionLimit:Int.MaxValuehostConnectionCoresize: 0hostConnectionIdleTime: Duration.TophostConnectionMaxWaiters:Int.MaxValuefailFast: truefailureAccrualParams,failureAccrualFactory:numFailures= 5,markDeadFor= 5 seconds
Advanced options:
Before changing any of these, make sure that you know exactly how they will affect your application -- these options are typically only changed by expert users.
keepAlive: Unspecified, in which case the Java default offalseis usedhostConnectionMaxIdleTime: Duration.TophostConnectionMaxLifeTime: Duration.Top
- See also
The user guide for information on the preferred
with-style and MethodBuilder client-construction APIs.
- trait ClientConfigEvidence[HasCluster, HasCodec, HasHostConnectionLimit] extends AnyRef
- Annotations
- @implicitNotFound()
- class IncompleteSpecification extends Exception
Used by builder to throw exceptions if the specification is incomplete.
Used by builder to throw exceptions if the specification is incomplete.
if (!_codec.isDefined) throw new IncompleteSpecification("No codec was specified")
- class SourceTrackingMonitor extends Monitor
A monitor that unrolls the exception causes to report source information if any
Value Members
- object ClientBuilder
Factory for com.twitter.finagle.builder.ClientBuilder instances
- object ClientConfig