vertx-lang-scala-docs_2.12 3.8.0 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
- 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 addEndpoint(value: SocketAddress): 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.

5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def asJava: redis.client.RedisOptions
7.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
8.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
9.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
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.  def getEndpoint: SocketAddress
13.  def getEndpoints: Buffer[SocketAddress]
14.  def getMasterName: String
15.  def getMaxNestedArrays: Int
16.  def getMaxWaitingHandlers: Int
17.  def getNetClientOptions: NetClientOptions
18.  def getPassword: String
19.  def getRole: RedisRole
20.  def getSelect: Int
21.  def getType: RedisClientType
22.  def getUseSlave: RedisSlaves
23.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
24.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
25.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
26.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
27.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
28.  def setEndpoint(value: SocketAddress): RedisOptions

    Sets a single endpoint to use while connecting to the redis server.

    Sets a single endpoint to use while connecting to the redis server. Will replace the previously configured endpoints.

29.  def setEndpoints(value: Buffer[SocketAddress]): RedisOptions
30.  def setMasterName(value: String): RedisOptions

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

31.  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.

32.  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.

33.  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.

34.  def setPassword(value: String): RedisOptions

    Set the provided password to be used when establishing a connection to the server.

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

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

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

    Set the provided database to be selected when establishing a connection to the server.

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

    Set the desired client type to be created.

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

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

39.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
40.  def toString(): String
    Definition Classes
      AnyRef → Any
41.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
42.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
43.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped