vertx-lang-scala-docs_2.12 3.9.1 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package redis
  Definition Classes
    scala
-  package client
  Definition Classes
    redis
- Command
- Redis
- RedisAPI
- RedisConnection
- RedisOptions
- Request
- Response

c

io.vertx.scala.redis.client

# RedisOptions 

###
Companion object RedisOptions

#### class RedisOptions extends AnyRef

Redis Client Configuration options.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. RedisOptions
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new RedisOptions(_asJava: redis.client.RedisOptions)

### 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 addConnectionString(value: String): RedisOptions

   Adds a connection string (endpoint) to use while connecting to the redis server.

   Adds a connection string (endpoint) to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.

   Does not support rediss (redis over ssl scheme) for now.

5.  def addEndpoint(value: String): RedisOptions

   Set the endpoints to use while connecting to the redis server.

   Set the endpoints to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.

6.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
7.  def asJava: redis.client.RedisOptions
8.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
9.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
10.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
11.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
12.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
13.  def getEndpoint: String
14.  def getEndpoints: Buffer[String]
15.  def getMasterName: String
16.  def getMaxNestedArrays: Int
17.  def getMaxPoolSize: Int
18.  def getMaxPoolWaiting: Int
19.  def getMaxWaitingHandlers: Int
20.  def getNetClientOptions: NetClientOptions
21.  def getPoolCleanerInterval: Int
22.  def getPoolRecycleTimeout: Int
23.  def getRole: RedisRole
24.  def getType: RedisClientType
25.  def getUseSlave: RedisSlaves
26.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
27.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
28.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
29.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
30.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
31.  def setConnectionString(value: String): RedisOptions

    Sets a single connection string (endpoint) to use while connecting to the redis server.

    Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings.

    Does not support rediss (redis over ssl scheme) for now.

32.  def setEndpoint(value: String): RedisOptions

    Sets a single connection string to use while connecting to the redis server.

    Sets a single connection string to use while connecting to the redis server. Will replace the previously configured connection strings.

33.  def setEndpoints(value: Buffer[String]): RedisOptions
34.  def setMasterName(value: String): RedisOptions

    Set the master name (only considered in HA mode).

35.  def setMaxNestedArrays(value: Int): RedisOptions

    Tune how much nested arrays are allowed on a redis response.

    Tune how much nested arrays are allowed on a redis response. This affects the parser performance.

36.  def setMaxPoolSize(value: Int): RedisOptions

    Tune the maximum size of the connection pool.

    Tune the maximum size of the connection pool. When working with cluster or sentinel this value should be atleast the total number of cluster member (or number of sentinels + 1)

37.  def setMaxPoolWaiting(value: Int): RedisOptions

    Tune the maximum waiting requests for a connection from the pool.

38.  def setMaxWaitingHandlers(value: Int): RedisOptions

    The client will always work on pipeline mode, this means that messages can start queueing.

    The client will always work on pipeline mode, this means that messages can start queueing. You can control how much backlog you're willing to accept. This methods sets how much handlers is the client willing to queue.

39.  def setNetClientOptions(value: NetClientOptions): RedisOptions

    Set the net client options to be used while connecting to the redis server.

    Set the net client options to be used while connecting to the redis server. Use this to tune your connection.

40.  def setPoolCleanerInterval(value: Int): RedisOptions

    Tune how often in milliseconds should the connection pool cleaner execute.

41.  def setPoolRecycleTimeout(value: Int): RedisOptions

    Tune when a connection should be recycled in milliseconds.

42.  def setRole(value: RedisRole): RedisOptions

    Set the role name (only considered in HA mode).

43.  def setType(value: RedisClientType): RedisOptions

    Set the desired client type to be created.

44.  def setUseSlave(value: RedisSlaves): RedisOptions

    Set whether or not to use slave nodes (only considered in Cluster mode).

45.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
46.  def toString(): String
    Definition Classes
      AnyRef → Any
47.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
48.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
49.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped