vertx-lang-scala-docs_2.12 3.7.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
-  package op
  Definition Classes
    redis
-  package sentinel
  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

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS 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
      @native() @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
    Annotations
      @native()
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 getDomainSocketAddress: String
22.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
23.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
24.  def getEncoding: String
25.  def getHost: String
26.  def getHostnameVerificationAlgorithm: String
    Definition Classes
      RedisOptions → NetClientOptions
27.  def getIdleTimeout: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
28.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
29.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
30.  def getKeyStoreOptions: JksOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
31.  def getLocalAddress: String
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
32.  def getLogActivity: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
33.  def getMasterName: String
34.  def getMetricsName: String
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
35.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
36.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
37.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
38.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
39.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
40.  def getPort: Int
41.  def getProxyOptions: ProxyOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
42.  def getReceiveBufferSize: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
43.  def getReconnectAttempts: Int
    Definition Classes
      RedisOptions → NetClientOptions
44.  def getReconnectInterval: Long
    Definition Classes
      RedisOptions → NetClientOptions
45.  def getSelect: Int
46.  def getSendBufferSize: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
47.  def getSentinels: Buffer[String]
48.  def getSoLinger: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
49.  def getSslHandshakeTimeout: Long
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
50.  def getSslHandshakeTimeoutUnit: TimeUnit
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
51.  def getTrafficClass: Int
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
52.  def getTrustStoreOptions: JksOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
53.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
54.  def isBinary: Boolean
55.  def isDomainSocket: Boolean
56.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
57.  def isReuseAddress: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
58.  def isReusePort: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
59.  def isSsl: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
60.  def isTcpCork: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
61.  def isTcpFastOpen: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
62.  def isTcpKeepAlive: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
63.  def isTcpNoDelay: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
64.  def isTcpQuickAck: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
65.  def isTrustAll: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
66.  def isUseAlpn: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
67.  def isUsePooledBuffers: Boolean
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
68.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
69.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
70.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
71.  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.

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

    Set the password for authentication at connection time.

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

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

    Set the connect timeout

    Set the connect timeout

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase
75.  def setDomainSocket(value: Boolean): RedisOptions

    Set the domain socket enabled option, default `false`.

76.  def setDomainSocketAddress(value: String): RedisOptions

    Set the domain socket address where the Redis server is listening.

77.  def setEnabledSecureTransportProtocols(value: Set[String]): RedisOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
78.  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

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

80.  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
81.  def setIdleTimeout(value: Int): RedisOptions

    Set the idle timeout, default time unit is seconds.

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

    If you want change default time unit, use NetClientOptions

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
82.  def setIdleTimeoutUnit(value: TimeUnit): RedisOptions

    Set the idle timeout unit.

    Set the idle timeout unit. If not specified, default is seconds.

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
83.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
84.  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
85.  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
86.  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
87.  def setMasterName(value: String): RedisOptions

    Set name of Redis master (used with Sentinel).

88.  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
89.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
90.  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
91.  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
92.  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
93.  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
94.  def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

95.  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
96.  def setReceiveBufferSize(value: Int): RedisOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

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

    Set the value of reconnect attempts

    Set the value of reconnect attempts

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

    Set the reconnect interval

    Set the reconnect interval

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

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
100.  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
101.  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

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

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
103.  def setSentinels(value: Buffer[String]): RedisOptions
104.  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
105.  def setSsl(value: Boolean): RedisOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
106.  def setSslHandshakeTimeout(value: Long): RedisOptions

     Set the SSL handshake timeout, default time unit is seconds.

     Set the SSL handshake timeout, default time unit is seconds.

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
107.  def setSslHandshakeTimeoutUnit(value: TimeUnit): RedisOptions

     Set the SSL handshake timeout unit.

     Set the SSL handshake timeout unit. If not specified, default is seconds.

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
108.  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
109.  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
110.  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
111.  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
112.  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
113.  def setTrafficClass(value: Int): RedisOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
114.  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
115.  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
116.  def setUseAlpn(value: Boolean): RedisOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
117.  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
118.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
119.  def toString(): String
     Definition Classes
       AnyRef → Any
120.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
121.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
122.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from NetClientOptions

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped