client

Type Members

1. case class DefaultClient[Req, Rep](name: String, endpointer: (SocketAddress, StatsReceiver) ⇒ ServiceFactory[Req, Rep], pool: (StatsReceiver) ⇒ Transformer[Req, Rep] = DefaultPool[Req, Rep](), maxIdletime: Duration = Duration.Top, maxLifetime: Duration = Duration.Top, requestTimeout: Duration = Duration.Top, failFast: Boolean = true, failureAccrual: Transformer[Req, Rep] = ..., serviceTimeout: Duration = Duration.Top, timer: Timer = DefaultTimer.twitter, statsReceiver: StatsReceiver = ClientStatsReceiver, hostStatsReceiver: StatsReceiver = NullStatsReceiver, tracer: Tracer = DefaultTracer, monitor: Monitor = DefaultMonitor, reporter: ReporterFactory = LoadedReporterFactory, loadBalancer: LoadBalancerFactory = DefaultBalancerFactory, newTraceInitializer: Stackable[ServiceFactory[Req, Rep]] = ...) extends Client[Req, Rep] with Product with Serializable

   

   A default client implementation that does load balancing and connection pooling.

   A default client implementation that does load balancing and connection pooling. The only required argument is a binder, responsible for binding concrete endpoints (named by SocketAddresses).

   name

   A name identifying the client.

   endpointer

   A function used to create a ServiceFactory to a concrete endpoint.

   pool

   The pool used to cache idle service (connection).

   maxIdletime

   The maximum time for which any Service is permitted to be idle.

   maxLifetime

   The maximum lifetime for any Service

   requestTimeout

   The maximum time that any request is allowed to take.

   failFast

   When enabled, installs a fail-fast module. See com.twitter.finagle.service.FailFastFactory

   failureAccrual

   A failure accruing mechanism. Used to gauge the health of the ServiceFactory. By default this uses com.twitter.finagle.client.DefaultClient.defaultFailureAccrual

   serviceTimeout

   The maximum amount of time allowed for acquiring a service. Defaults to infinity.

2. case class DefaultPool[Req, Rep](low: Int = 0, high: Int = Int.MaxValue, bufferSize: Int = 0, idleTime: Duration = Duration.Top, maxWaiters: Int = Int.MaxValue, timer: Timer = DefaultTimer.twitter) extends (StatsReceiver) ⇒ Transformer[Req, Rep] with Product with Serializable

   

   Create a watermark pool backed by a caching pool.

   Create a watermark pool backed by a caching pool. This is the default pooling setup of Finagle.

   low

   The low watermark used in the Watermark pool. If there is sufficient request concurrency, no fewer connections will be maintained by the pool.

   high

   The high watermark. The pool will not maintain more connections than this.

   bufferSize

   Specifies the size of the lock-free buffer in front of the pool configuration. Skipped if 0.

   idleTime

   The amount of idle time for which a connection is cached. This is applied to connections that number greater than the low watermark but fewer than the high.

   maxWaiters

   The maximum number of connection requests that are queued when the connection concurrency exceeds the high watermark.

3. trait StackBasedClient[Req, Rep] extends Client[Req, Rep] with Parameterized[StackBasedClient[Req, Rep]] with Transformable[StackBasedClient[Req, Rep]]

   

   A Client that may have its Stack transformed.

   A Client that may have its Stack transformed.

   A StackBasedClient is weaker than a StackClient in that the specific Req, Rep types of its stack are not exposed.

4. trait StackClient[Req, Rep] extends StackBasedClient[Req, Rep] with Parameterized[StackClient[Req, Rep]] with Transformable[StackClient[Req, Rep]]

   

   A Client that composes a Stack.

5. trait StdStackClient[Req, Rep, This <: StdStackClient[Req, Rep, This]] extends StackClient[Req, Rep] with Parameterized[This] with CommonParams[This] with ClientParams[This] with WithClientAdmissionControl[This] with WithClientTransport[This] with WithSession[This] with WithSessionQualifier[This]

   

   The standard template implementation for com.twitter.finagle.client.StackClient.

6. type Transformer[Req, Rep] = (ServiceFactory[Req, Rep]) ⇒ ServiceFactory[Req, Rep]

   

   Transform a service factory stack.

7. trait Transporter[In, Out] extends AnyRef

   

   Transporters are simple functions from a SocketAddress to a Future[Transport[In, Out]].

   Transporters are simple functions from a SocketAddress to a Future[Transport[In, Out]]. They represent a transport layer session from a client to a server. Transporters are symmetric to the server-side com.twitter.finagle.server.Listener.