Packages

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.

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
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  5. def addCrlValue(value: Buffer): RedisOptions

    Add a CRL value

    Add a CRL value

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

    Set the eventbus address prefix for PUB/SUB.

  60. def setAuth(value: String): RedisOptions

    Set the password for authentication at connection time.

  61. def setBinary(value: Boolean): RedisOptions

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

  62. def setConnectTimeout(value: Int): RedisOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBase
  63. def setEncoding(value: String): RedisOptions

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

  64. def setHost(value: String): RedisOptions

    Set the host name where the Redis server is listening.

  65. 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
    RedisOptionsNetClientOptions
  66. 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
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  67. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
  68. 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
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  69. 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
    RedisOptionsNetClientOptionsClientOptionsBase
  70. 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
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  71. 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
    RedisOptionsNetClientOptionsClientOptionsBase
  72. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
  73. 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
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  74. def setPemTrustOptions(value: PemTrustOptions): RedisOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  75. def setPfxKeyCertOptions(value: PfxOptions): RedisOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  76. def setPfxTrustOptions(value: PfxOptions): RedisOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  77. def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

  78. 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
    RedisOptionsNetClientOptionsClientOptionsBase
  79. def setReceiveBufferSize(value: Int): RedisOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  80. def setReconnectAttempts(value: Int): RedisOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
    RedisOptionsNetClientOptions
  81. def setReconnectInterval(value: Long): RedisOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
    RedisOptionsNetClientOptions
  82. def setReuseAddress(value: Boolean): RedisOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  83. def setSelect(value: Int): RedisOptions

    Set the database to select at connection time.

  84. def setSendBufferSize(value: Int): RedisOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  85. def setSoLinger(value: Int): RedisOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  86. def setSsl(value: Boolean): RedisOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  87. def setTcpKeepAlive(value: Boolean): RedisOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  88. def setTcpNoDelay(value: Boolean): RedisOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  89. def setTrafficClass(value: Int): RedisOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  90. def setTrustAll(value: Boolean): RedisOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBase
  91. 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
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  92. def setUseAlpn(value: Boolean): RedisOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  93. def setUsePooledBuffers(value: Boolean): RedisOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    RedisOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  94. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  95. def toString(): String
    Definition Classes
    AnyRef → Any
  96. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. 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