vertx-lang-scala-docs_2.12 3.4.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 op
  Definition Classes
    redis
- RedisClient
- RedisOptions
- RedisTransaction

c

io.vertx.scala.redis

# RedisOptions 

###
Companion object RedisOptions

#### class RedisOptions extends AnyRef

This object controls the connection setting to the Redis Server. There is no need to specify most of the settings since it has built the following sensible defaults:

* `encoding`: `UTF-8` * `host`: `localhost` * `port`: 6379 * `tcpKeepAlive`: true * `tcpNoDelay`: true * `binary`: false

However there are two extra properties that have no defaults since they are optional:

* `auth` * `select`

The usage of this two extra properties is to setup required authentication and optionally the selection of the active database at connection time. If you define this extra properties on every connection to Redis server this client will perform the authentication handshake and database selection, however if you don't do this and call io.vertx.scala.redis.RedisClient yourself in case of connection failure the client will not be able to perform the correct authentication handshake.

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.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.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def asJava: redis.RedisOptions
6.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... )
7.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
8.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
9.  def finalize(): Unit
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] )
10.  def getAddress: String
11.  def getAuth: String
12.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
13.  def getEncoding: String
14.  def getHost: String
15.  def getPort: Int
16.  def getSelect: Int
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
18.  def isBinary: Boolean
19.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
20.  def isTcpKeepAlive: Boolean
21.  def isTcpNoDelay: Boolean
22.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
23.  final def notify(): Unit
    Definition Classes
      AnyRef
24.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
25.  def setAddress(value: String): RedisOptions

    Set the eventbus address prefix for `PUB/SUB`.

26.  def setAuth(value: String): RedisOptions

    Set the password for authentication at connection time.

27.  def setBinary(value: Boolean): RedisOptions

    Set the user defined character encoding, e.g.: `iso-8859-1`.

28.  def setEncoding(value: String): RedisOptions

    Set the user defined character encoding, e.g.: `iso-8859-1`.

29.  def setHost(value: String): RedisOptions

    Set the host name where the Redis server is listening.

30.  def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

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

    Set the database to select at connection time.

32.  def setTcpKeepAlive(value: Boolean): RedisOptions

    Set the TCP KeepAlive option

33.  def setTcpNoDelay(value: Boolean): RedisOptions

    Set the TCP NoDelay at the socket level.

34.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
35.  def toString(): String
    Definition Classes
      AnyRef → Any
36.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
37.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
38.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped