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. 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 isSsl: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  54. def isTcpKeepAlive: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  55. def isTcpNoDelay: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  56. def isTrustAll: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  57. def isUseAlpn: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  58. def isUsePooledBuffers: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  59. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  60. final def notify(): Unit
    Definition Classes
    AnyRef
  61. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  62. 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.

  63. def setAuth(value: String): RedisOptions

    Set the password for authentication at connection time.

  64. def setBinary(value: Boolean): RedisOptions

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

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

  65. def setConnectTimeout(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  66. 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

  67. 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

  68. def setHostnameVerificationAlgorithm(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  69. def setIdleTimeout(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  70. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  71. def setKeyStoreOptions(value: JksOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  72. def setLocalAddress(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  73. def setLogActivity(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  74. def setMasterName(value: String): RedisOptions

    Set name of Redis master (used with Sentinel).

  75. def setMetricsName(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  76. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  77. def setPemKeyCertOptions(value: PemKeyCertOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  78. def setPemTrustOptions(value: PemTrustOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  79. def setPfxKeyCertOptions(value: PfxOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  80. def setPfxTrustOptions(value: PfxOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  81. def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

  82. def setProxyOptions(value: ProxyOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  83. def setReceiveBufferSize(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  84. def setReconnectAttempts(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  85. def setReconnectInterval(value: Long): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  86. def setReuseAddress(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  87. 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

  88. def setSendBufferSize(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  89. def setSentinels(value: Buffer[String]): RedisOptions
  90. def setSoLinger(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  91. def setSsl(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  92. def setTcpKeepAlive(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  93. def setTcpNoDelay(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  94. def setTrafficClass(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  95. def setTrustAll(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  96. def setTrustStoreOptions(value: JksOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  97. def setUseAlpn(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  98. def setUsePooledBuffers(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  99. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  100. def toString(): String
    Definition Classes
    AnyRef → Any
  101. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  102. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  103. 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