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.
- Alphabetic
- By Inheritance
- RedisOptions
- NetClientOptions
- ClientOptionsBase
- TCPSSLOptions
- NetworkOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new RedisOptions(_asJava: redis.RedisOptions)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addCrlPath(value: String): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addCrlValue(value: Buffer): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addEnabledCipherSuite(value: String): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addEnabledSecureTransportProtocol(value: String): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: redis.RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def getAddress: String
- def getAuth: String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getConnectTimeout: Int
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
getCrlPaths: Buffer[String]
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getCrlValues: Buffer[Buffer]
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getEnabledCipherSuites: Set[String]
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getEnabledSecureTransportProtocols: Set[String]
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getEncoding: String
- def getHost: String
-
def
getHostnameVerificationAlgorithm: String
- Definition Classes
- RedisOptions → NetClientOptions
-
def
getIdleTimeout: Int
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getJdkSslEngineOptions: JdkSSLEngineOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getKeyStoreOptions: JksOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getLocalAddress: String
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
getLogActivity: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getMetricsName: String
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
getOpenSslEngineOptions: OpenSSLEngineOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPemKeyCertOptions: PemKeyCertOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPemTrustOptions: PemTrustOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPfxKeyCertOptions: PfxOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPfxTrustOptions: PfxOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getPort: Int
-
def
getProxyOptions: ProxyOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
getReceiveBufferSize: Int
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getReconnectAttempts: Int
- Definition Classes
- RedisOptions → NetClientOptions
-
def
getReconnectInterval: Long
- Definition Classes
- RedisOptions → NetClientOptions
- def getSelect: Int
-
def
getSendBufferSize: Int
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getSoLinger: Int
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getTrafficClass: Int
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getTrustStoreOptions: JksOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- def isBinary: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isReuseAddress: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
isSsl: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpKeepAlive: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpNoDelay: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTrustAll: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
isUseAlpn: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isUsePooledBuffers: Boolean
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
setAddress(value: String): RedisOptions
Set the eventbus address prefix for
PUB/SUB
. -
def
setAuth(value: String): RedisOptions
Set the password for authentication at connection time.
-
def
setBinary(value: Boolean): RedisOptions
Set the user defined character encoding, e.g.:
iso-8859-1
. -
def
setConnectTimeout(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
setEncoding(value: String): RedisOptions
Set the user defined character encoding, e.g.:
iso-8859-1
. -
def
setHost(value: String): RedisOptions
Set the host name where the Redis server is listening.
-
def
setHostnameVerificationAlgorithm(value: String): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions
-
def
setIdleTimeout(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setKeyStoreOptions(value: JksOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setLocalAddress(value: String): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
setLogActivity(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setMetricsName(value: String): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPemKeyCertOptions(value: PemKeyCertOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPemTrustOptions(value: PemTrustOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPfxKeyCertOptions(value: PfxOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPfxTrustOptions(value: PfxOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setPort(value: Int): RedisOptions
Set the tcp port where the Redis server is listening.
-
def
setProxyOptions(value: ProxyOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
setReceiveBufferSize(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setReconnectAttempts(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions
-
def
setReconnectInterval(value: Long): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions
-
def
setReuseAddress(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setSelect(value: Int): RedisOptions
Set the database to select at connection time.
-
def
setSendBufferSize(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setSoLinger(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setSsl(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpKeepAlive(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTcpNoDelay(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setTrafficClass(value: Int): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setTrustAll(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase
-
def
setTrustStoreOptions(value: JksOptions): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setUseAlpn(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setUsePooledBuffers(value: Boolean): RedisOptions
- Definition Classes
- RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )