Packages

case class NodeConfig(poolSize: Int = 1, maxBlockingPoolSize: Int = 4096, maxBlockingIdleTime: Duration = 1.minute, blockingCleanupInterval: FiniteDuration = 1.second, initOp: RedisOp[Any] = RedisOp.unit, initTimeout: Timeout = Timeout(10.seconds), connectionConfigs: (Int) ⇒ ConnectionConfig = _ => ConnectionConfig(), blockingConnectionConfigs: (Int) ⇒ ConnectionConfig = _ => ConnectionConfig()) extends Product with Serializable

Configuration of a RedisNodeClient, used either as a standalone client or internally by RedisClusterClient.

poolSize

Number of connections used by node client. Commands are distributed between connections using a round-robin scenario. Number of connections in the pool is constant and cannot be changed. Due to single-threaded nature of Redis, the number of concurrent connections should be kept low for best performance. The only situation where the number of connections should be increased is when using WATCH-MULTI-EXEC transactions with optimistic locking.

maxBlockingPoolSize

Maximum number of connections used by node client in order to handle blocking Redis commands, e.g. BLPOP. Blocking commands may not be pipelined with other, independent commands because these other commands may be delayed by the blocking command. Therefore they require their own, dynamically resizable connection pool. Maximum size of that pool is the limit of possible concurrent blocking commands that can be executed at the same time.

maxBlockingIdleTime

Maximum amount of time a blocking connection may be idle before being closed and removed from the pool.

blockingCleanupInterval

Time interval between periodic blocking connection cleanup events, with respect to maxBlockingIdleTime.

initOp

A RedisOp executed by this client upon initialization. This may be useful for things like script loading, especially when using cluster client which may create and close node clients dynamically as reactions on cluster state changes.

initTimeout

Timeout used by initialization operation (initOp)

connectionConfigs

A function that returns ConnectionConfig for a connection given its id. Connection ID is its index in the connection pool, i.e. an int ranging from 0 to poolSize-1.

blockingConnectionConfigs

Same as connectionConfigs but for connections used for handling blocking commands.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NodeConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NodeConfig(poolSize: Int = 1, maxBlockingPoolSize: Int = 4096, maxBlockingIdleTime: Duration = 1.minute, blockingCleanupInterval: FiniteDuration = 1.second, initOp: RedisOp[Any] = RedisOp.unit, initTimeout: Timeout = Timeout(10.seconds), connectionConfigs: (Int) ⇒ ConnectionConfig = _ => ConnectionConfig(), blockingConnectionConfigs: (Int) ⇒ ConnectionConfig = _ => ConnectionConfig())

    poolSize

    Number of connections used by node client. Commands are distributed between connections using a round-robin scenario. Number of connections in the pool is constant and cannot be changed. Due to single-threaded nature of Redis, the number of concurrent connections should be kept low for best performance. The only situation where the number of connections should be increased is when using WATCH-MULTI-EXEC transactions with optimistic locking.

    maxBlockingPoolSize

    Maximum number of connections used by node client in order to handle blocking Redis commands, e.g. BLPOP. Blocking commands may not be pipelined with other, independent commands because these other commands may be delayed by the blocking command. Therefore they require their own, dynamically resizable connection pool. Maximum size of that pool is the limit of possible concurrent blocking commands that can be executed at the same time.

    maxBlockingIdleTime

    Maximum amount of time a blocking connection may be idle before being closed and removed from the pool.

    blockingCleanupInterval

    Time interval between periodic blocking connection cleanup events, with respect to maxBlockingIdleTime.

    initOp

    A RedisOp executed by this client upon initialization. This may be useful for things like script loading, especially when using cluster client which may create and close node clients dynamically as reactions on cluster state changes.

    initTimeout

    Timeout used by initialization operation (initOp)

    connectionConfigs

    A function that returns ConnectionConfig for a connection given its id. Connection ID is its index in the connection pool, i.e. an int ranging from 0 to poolSize-1.

    blockingConnectionConfigs

    Same as connectionConfigs but for connections used for handling blocking commands.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val blockingCleanupInterval: FiniteDuration
  6. val blockingConnectionConfigs: (Int) ⇒ ConnectionConfig
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. val connectionConfigs: (Int) ⇒ ConnectionConfig
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. val initOp: RedisOp[Any]
  13. val initTimeout: Timeout
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val maxBlockingIdleTime: Duration
  16. val maxBlockingPoolSize: Int
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val poolSize: Int
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped