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
    @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 getTrafficClass: Int
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  50. def getTrustStoreOptions: JksOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  51. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  52. def isBinary: Boolean
  53. def isDomainSocket: Boolean
  54. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  55. def isReuseAddress: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  56. def isReusePort: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  57. def isSsl: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  58. def isTcpCork: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  59. def isTcpFastOpen: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  60. def isTcpKeepAlive: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  61. def isTcpNoDelay: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  62. def isTcpQuickAck: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  63. def isTrustAll: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  64. def isUseAlpn: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  65. def isUsePooledBuffers: Boolean
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  66. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  68. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. 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.

  70. def setAuth(value: String): RedisOptions

    Set the password for authentication at connection time.

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

  72. def setConnectTimeout(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  73. def setDomainSocket(value: Boolean): RedisOptions

    Set the domain socket enabled option, default false.

  74. def setDomainSocketAddress(value: String): RedisOptions

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

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

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

  78. def setHostnameVerificationAlgorithm(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  79. def setIdleTimeout(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  80. def setIdleTimeoutUnit(value: TimeUnit): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  81. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  82. def setKeyStoreOptions(value: JksOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  83. def setLocalAddress(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  84. def setLogActivity(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  85. def setMasterName(value: String): RedisOptions

    Set name of Redis master (used with Sentinel).

  86. def setMetricsName(value: String): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  87. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  88. def setPemKeyCertOptions(value: PemKeyCertOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  89. def setPemTrustOptions(value: PemTrustOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  90. def setPfxKeyCertOptions(value: PfxOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  91. def setPfxTrustOptions(value: PfxOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  92. def setPort(value: Int): RedisOptions

    Set the tcp port where the Redis server is listening.

  93. def setProxyOptions(value: ProxyOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  94. def setReceiveBufferSize(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  95. def setReconnectAttempts(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  96. def setReconnectInterval(value: Long): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions
  97. def setReuseAddress(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  98. def setReusePort(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  99. 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

  100. def setSendBufferSize(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  101. def setSentinels(value: Buffer[String]): RedisOptions
  102. def setSoLinger(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  103. def setSsl(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  104. def setTcpCork(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  105. def setTcpFastOpen(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  106. def setTcpKeepAlive(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  107. def setTcpNoDelay(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  108. def setTcpQuickAck(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  109. def setTrafficClass(value: Int): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  110. def setTrustAll(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase
  111. def setTrustStoreOptions(value: JksOptions): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  112. def setUseAlpn(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  113. def setUsePooledBuffers(value: Boolean): RedisOptions
    Definition Classes
    RedisOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  114. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  115. def toString(): String
    Definition Classes
    AnyRef → Any
  116. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  117. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  118. 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