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

c

io.vertx.scala.redis

# RedisOptions 

###
Companion object RedisOptions

#### class RedisOptions extends NetClientOptions

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
NetClientOptions, ClientOptionsBase, TCPSSLOptions, NetworkOptions, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. RedisOptions
2. NetClientOptions
3. ClientOptionsBase
4. TCPSSLOptions
5. NetworkOptions
6. AnyRef
7. 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.  def addCrlPath(value: String): RedisOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
5.  def addCrlValue(value: Buffer): RedisOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
6.  def addEnabledCipherSuite(value: String): RedisOptions

   Add an enabled cipher suite, appended to the ordered suites.

   Add an enabled cipher suite, appended to the ordered suites.

   Definition Classes
     RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): RedisOptions

   Add an enabled SSL/TLS protocols, appended to the ordered protocols.

   Add an enabled SSL/TLS protocols, appended to the ordered protocols.

   Definition Classes
     RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
8.  def addSentinel(value: String): RedisOptions

   Set the list of Sentinels.

9.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
10.  def asJava: redis.RedisOptions
    Definition Classes
      RedisOptions → NetClientOptions
11.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  def getAddress: String
16.  def getAuth: String
17.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
18.  def getConnectTimeout: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
19.  def getCrlPaths: Buffer[String]
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
20.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
21.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
22.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
23.  def getEncoding: String
24.  def getHost: String
25.  def getHostnameVerificationAlgorithm: String
    Definition Classes
      RedisOptions → NetClientOptions
26.  def getIdleTimeout: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
27.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
28.  def getKeyStoreOptions: JksOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
29.  def getLocalAddress: String
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
30.  def getLogActivity: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
31.  def getMasterName: String
32.  def getMetricsName: String
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
33.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
34.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
35.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
36.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
37.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
38.  def getPort: Int
39.  def getProxyOptions: ProxyOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
40.  def getReceiveBufferSize: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
41.  def getReconnectAttempts: Int
    Definition Classes
      RedisOptions → NetClientOptions
42.  def getReconnectInterval: Long
    Definition Classes
      RedisOptions → NetClientOptions
43.  def getSelect: Int
44.  def getSendBufferSize: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
45.  def getSentinels: Buffer[String]
46.  def getSoLinger: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
47.  def getTrafficClass: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
48.  def getTrustStoreOptions: JksOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
49.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
50.  def isBinary: Boolean
51.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
52.  def isReuseAddress: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
53.  def isReusePort: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
54.  def isSsl: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
55.  def isTcpCork: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
56.  def isTcpFastOpen: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
57.  def isTcpKeepAlive: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
58.  def isTcpNoDelay: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
59.  def isTcpQuickAck: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
60.  def isTrustAll: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
61.  def isUseAlpn: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
62.  def isUsePooledBuffers: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
63.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
64.  final def notify(): Unit
    Definition Classes
      AnyRef
65.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
66.  def setAddress(value: String): RedisOptions

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

    Set the eventbus address prefix for `PUB/SUB`. * @param address address prefix.

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

    Set the password for authentication at connection time.

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

    Set the messages to/from redis as binary, default `false`.

    Set the messages to/from redis as binary, default `false`. * @param binary use binary messages

69.  def setConnectTimeout(value: Int): RedisOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
70.  def setEncoding(value: String): RedisOptions

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

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

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

    Set the host name where the Redis server is listening.

    Set the host name where the Redis server is listening. * @param host host name

72.  def setHostnameVerificationAlgorithm(value: String): RedisOptions

    Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    Definition Classes
      RedisOptions → NetClientOptions
73.  def setIdleTimeout(value: Int): RedisOptions

    Set the idle timeout, in seconds.

    Set the idle timeout, in seconds. zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
74.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
75.  def setKeyStoreOptions(value: JksOptions): RedisOptions

    Set the key/cert options in jks format, aka Java keystore.

    Set the key/cert options in jks format, aka Java keystore.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
76.  def setLocalAddress(value: String): RedisOptions

    Set the local interface to bind for network connections.

    Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
77.  def setLogActivity(value: Boolean): RedisOptions

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
78.  def setMasterName(value: String): RedisOptions

    Set name of Redis master (used with Sentinel).

79.  def setMetricsName(value: String): RedisOptions

    Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

    Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
80.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
81.  def setPemKeyCertOptions(value: PemKeyCertOptions): RedisOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
82.  def setPemTrustOptions(value: PemTrustOptions): RedisOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
83.  def setPfxKeyCertOptions(value: PfxOptions): RedisOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
84.  def setPfxTrustOptions(value: PfxOptions): RedisOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
85.  def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

86.  def setProxyOptions(value: ProxyOptions): RedisOptions

    Set proxy options for connections via CONNECT proxy (e.g.

    Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
87.  def setReceiveBufferSize(value: Int): RedisOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
88.  def setReconnectAttempts(value: Int): RedisOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
      RedisOptions → NetClientOptions
89.  def setReconnectInterval(value: Long): RedisOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
      RedisOptions → NetClientOptions
90.  def setReuseAddress(value: Boolean): RedisOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
91.  def setReusePort(value: Boolean): RedisOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
92.  def setSelect(value: Int): RedisOptions

    Set the database to select at connection time.

    Set the database to select at connection time. * @param select database id

93.  def setSendBufferSize(value: Int): RedisOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
94.  def setSentinels(value: Buffer[String]): RedisOptions
95.  def setSoLinger(value: Int): RedisOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
96.  def setSsl(value: Boolean): RedisOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
97.  def setTcpCork(value: Boolean): RedisOptions

    Enable the `TCP_CORK` option - only with linux native transport.

    Enable the `TCP_CORK` option - only with linux native transport.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
98.  def setTcpFastOpen(value: Boolean): RedisOptions

    Enable the `TCP_FASTOPEN` option - only with linux native transport.

    Enable the `TCP_FASTOPEN` option - only with linux native transport.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
99.  def setTcpKeepAlive(value: Boolean): RedisOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
100.  def setTcpNoDelay(value: Boolean): RedisOptions

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
101.  def setTcpQuickAck(value: Boolean): RedisOptions

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
102.  def setTrafficClass(value: Int): RedisOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
103.  def setTrustAll(value: Boolean): RedisOptions

     Set whether all server certificates should be trusted

     Set whether all server certificates should be trusted

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase
104.  def setTrustStoreOptions(value: JksOptions): RedisOptions

     Set the trust options in jks format, aka Java truststore

     Set the trust options in jks format, aka Java truststore

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
105.  def setUseAlpn(value: Boolean): RedisOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
106.  def setUsePooledBuffers(value: Boolean): RedisOptions

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
107.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
108.  def toString(): String
     Definition Classes
       AnyRef → Any
109.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
110.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
111.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )

### Inherited from NetClientOptions

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped