class ClientSessionParams[A <: Parameterized[A]] extends SessionParams[A]
A collection of methods for configuring sessions of the Finagle clients.
Session might be viewed as logical connection that wraps a physical connection (i.e., transport) and controls its lifecycle. Sessions are used in Finagle to maintain liveness, requests cancellation, draining, and much more.
- A
a Stack.Parameterized client to configure.
- See also
SessionPoolingParams for pooling related configuration.
- Alphabetic
- By Inheritance
- ClientSessionParams
- SessionParams
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ClientSessionParams(self: Parameterized[A])
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
acquisitionTimeout(timeout: Duration): A
Configures the session acquisition
timeout
of this client (default: unbounded).Configures the session acquisition
timeout
of this client (default: unbounded).This timeout is applied to the acquisition of a service and includes both queueing time (e.g. because we cannot create more connections due to connections limit and there are outstanding requests) as well as physical TCP connection time. Futures returned from
factory()
will always be satisfied within this timeout plus any applied com.twitter.finagle.client.LatencyCompensation.This timeout also includes the following, but the cost is amortized over subsequent acquisitions of the same (possibly cached) session:
- Resolving logical destinations - SSL handshake if configured - HTTP proxy handshake if configured
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
maxLifeTime(timeout: Duration): A
Configures the session lifetime
timeout
- the maximum amount of time a given connection is allowed to live before it is closed (default: unbounded).Configures the session lifetime
timeout
- the maximum amount of time a given connection is allowed to live before it is closed (default: unbounded).- Definition Classes
- SessionParams
- See also
https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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
- @native() @throws( ... )