Packages

c

com.twitter.finagle.param

ClientSessionParams

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.

Linear Supertypes
SessionParams[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientSessionParams
  2. SessionParams
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClientSessionParams(self: Parameterized[A])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. 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

    See also

    https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. 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

  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from SessionParams[A]

Inherited from AnyRef

Inherited from Any

Ungrouped