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.

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
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  5. def addCrlValue(value: Buffer): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  6. def addEnabledCipherSuite(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asJava: redis.RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  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
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  18. def getCrlPaths: Buffer[String]
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  19. def getCrlValues: Buffer[Buffer]
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  20. def getEnabledCipherSuites: Set[String]
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  21. def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  22. def getEncoding: String
  23. def getHost: String
  24. def getHostnameVerificationAlgorithm: String
    Definition Classes
    RedisOptions → NetClientOptions
  25. def getIdleTimeout: Int
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  26. def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  27. def getKeyStoreOptions: JksOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  28. def getLocalAddress: String
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  29. def getLogActivity: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  30. def getMetricsName: String
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  31. def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  32. def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  33. def getPemTrustOptions: PemTrustOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  34. def getPfxKeyCertOptions: PfxOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  35. def getPfxTrustOptions: PfxOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  36. def getPort: Int
  37. def getProxyOptions: ProxyOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  38. def getReceiveBufferSize: Int
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  39. def getReconnectAttempts: Int
    Definition Classes
    RedisOptions → NetClientOptions
  40. def getReconnectInterval: Long
    Definition Classes
    RedisOptions → NetClientOptions
  41. def getSelect: Int
  42. def getSendBufferSize: Int
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  43. def getSoLinger: Int
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  44. def getTrafficClass: Int
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  45. def getTrustStoreOptions: JksOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  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
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  50. def isSsl: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  51. def isTcpKeepAlive: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  52. def isTcpNoDelay: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  53. def isTrustAll: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  54. def isUseAlpn: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  55. def isUsePooledBuffers: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  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
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  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
    Definition Classes
    RedisOptions → NetClientOptions
  66. def setIdleTimeout(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  67. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  68. def setKeyStoreOptions(value: JksOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  69. def setLocalAddress(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  70. def setLogActivity(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  71. def setMetricsName(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  72. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  73. def setPemKeyCertOptions(value: PemKeyCertOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  74. def setPemTrustOptions(value: PemTrustOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  75. def setPfxKeyCertOptions(value: PfxOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  76. def setPfxTrustOptions(value: PfxOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  77. def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

  78. def setProxyOptions(value: ProxyOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  79. def setReceiveBufferSize(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  80. def setReconnectAttempts(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  81. def setReconnectInterval(value: Long): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  82. def setReuseAddress(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  83. def setSelect(value: Int): RedisOptions

    Set the database to select at connection time.

  84. def setSendBufferSize(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  85. def setSoLinger(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  86. def setSsl(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  87. def setTcpKeepAlive(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  88. def setTcpNoDelay(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  89. def setTrafficClass(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  90. def setTrustAll(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  91. def setTrustStoreOptions(value: JksOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  92. def setUseAlpn(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  93. def setUsePooledBuffers(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  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