com.twitter.finagle.param.SessionPoolingParams.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of finagle-core_2.11 Show documentation

finagle-core

There is a newer version: 7.0.0

package com.twitter.finagle.param

import com.twitter.finagle.Stack
import com.twitter.finagle.client.DefaultPool

/**
 * A collection of methods for configuring the Pooling module of Finagle clients.
 *
 * @tparam A a [[Stack.Parameterized]] client to configure
 *
 * @see [[https://twitter.github.io/finagle/guide/Clients.html#pooling]]
 */
class SessionPoolingParams[A <: Stack.Parameterized[A]](self: Stack.Parameterized[A]) {

  /**
   * Configures the total number of temporary (may be closed and reestablished, depending
   * on the [[SessionParams.maxLifeTime session lifetime]]) and persistent (remain
   * open during the lifetime of a given client/pool per-host sessions of this client's
   * pool (default: unbounded).
   *
   * @note The session pool will not have more active sessions than `sessionsPerHost`.
   *
   * @see [[https://twitter.github.io/finagle/guide/Clients.html#pooling]]
   */
  def maxSize(sessionsPerHost: Int): A =
    self.configured(self.params[DefaultPool.Param].copy(high = sessionsPerHost))

  /**
   * Configures the number of per-host persistent (remain open during the
   * lifetime of a given client/pool) sessions of this client's pool (default: 0).
   *
   * @note The session pool will not be shrinked below `sessionsPerHost`.
   *
   * @see [[https://twitter.github.io/finagle/guide/Clients.html#pooling]]
   */
  def minSize(sessionsPerHost: Int): A =
    self.configured(self.params[DefaultPool.Param].copy(low = sessionsPerHost))

  /**
   *
   * Configures the maximum number of per-host sessions requests that are queued
   * when the connections concurrency exceeds the maximum size of this pool
   * (default: unbounded).
   *
   * @see [[https://twitter.github.io/finagle/guide/Clients.html#pooling]]
   */
  def maxWaiters(maxWaitersPerHost: Int): A =
    self.configured(self.params[DefaultPool.Param].copy(maxWaiters = maxWaitersPerHost))
}