Class

com.twitter.finagle.param

ClientSessionParams

Related Doc: package param

Permalink

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

Instance Constructors

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

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def acquisitionTimeout(timeout: Duration): A

    Permalink

    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.

    This timeout also includes resolving logical destinations, but the cost of resolution is amortized.

    See also

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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. def maxIdleTime(timeout: Duration): A

    Permalink

    Configures the session max idle time timeout - the maximum amount of time a given session is allowed to be idle before it is closed (default: unbounded).

    Configures the session max idle time timeout - the maximum amount of time a given session is allowed to be idle before it is closed (default: unbounded).

    Definition Classes
    SessionParams
    See also

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

  14. def maxLifeTime(timeout: Duration): A

    Permalink

    Configures the session lifetime timeout - the maximum amount of time a given service is allowed to live before it is closed (default: unbounded).

    Configures the session lifetime timeout - the maximum amount of time a given service 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

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from SessionParams[A]

Inherited from AnyRef

Inherited from Any

Ungrouped