vertx / io.vertx.kotlin.redis / RedisOptions

# RedisOptions

`fun RedisOptions(address: String? = null, auth: String? = null, binary: Boolean? = null, connectTimeout: Int? = null, crlPaths: Iterable<String>? = null, crlValues: Iterable<Buffer>? = null, domainSocket: Boolean? = null, domainSocketAddress: String? = null, enabledCipherSuites: Iterable<String>? = null, enabledSecureTransportProtocols: Iterable<String>? = null, encoding: String? = null, host: String? = null, hostnameVerificationAlgorithm: String? = null, idleTimeout: Int? = null, jdkSslEngineOptions: JdkSSLEngineOptions? = null, keyStoreOptions: JksOptions? = null, localAddress: String? = null, logActivity: Boolean? = null, masterName: String? = null, metricsName: String? = null, openSslEngineOptions: OpenSSLEngineOptions? = null, pemKeyCertOptions: PemKeyCertOptions? = null, pemTrustOptions: PemTrustOptions? = null, pfxKeyCertOptions: PfxOptions? = null, pfxTrustOptions: PfxOptions? = null, port: Int? = null, proxyOptions: ProxyOptions? = null, receiveBufferSize: Int? = null, reconnectAttempts: Int? = null, reconnectInterval: Long? = null, reuseAddress: Boolean? = null, reusePort: Boolean? = null, select: Int? = null, sendBufferSize: Int? = null, sentinels: Iterable<String>? = null, soLinger: Int? = null, ssl: Boolean? = null, tcpCork: Boolean? = null, tcpFastOpen: Boolean? = null, tcpKeepAlive: Boolean? = null, tcpNoDelay: Boolean? = null, tcpQuickAck: Boolean? = null, trafficClass: Int? = null, trustAll: Boolean? = null, trustStoreOptions: JksOptions? = null, useAlpn: Boolean? = null, usePooledBuffers: Boolean? = null): RedisOptions`

A function providing a DSL for building io.vertx.redis.RedisOptions objects.

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:

### Parameters

`address` - Set the eventbus address prefix for `PUB/SUB`. * @param address address prefix.

`auth` - Set the password for authentication at connection time.

`binary` - Set the messages to/from redis as binary, default `false`. * @param binary use binary messages

`connectTimeout` -

`crlPaths` -

`crlValues` -

`domainSocket` - Set the domain socket enabled option, default `false`.

`domainSocketAddress` - Set the domain socket address where the Redis server is listening.

`enabledCipherSuites` -

`enabledSecureTransportProtocols` -

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

`host` - Set the host name where the Redis server is listening. * @param host host name

`hostnameVerificationAlgorithm` -

`idleTimeout` -

`jdkSslEngineOptions` -

`keyStoreOptions` -

`localAddress` -

`logActivity` -

`masterName` - Set name of Redis master (used with Sentinel).

`metricsName` -

`openSslEngineOptions` -

`pemKeyCertOptions` -

`pemTrustOptions` -

`pfxKeyCertOptions` -

`pfxTrustOptions` -

`port` - Set the tcp port where the Redis server is listening.

`proxyOptions` -

`receiveBufferSize` -

`reconnectAttempts` -

`reconnectInterval` -

`reuseAddress` -

`reusePort` -

`select` - Set the database to select at connection time. * @param select database id

`sendBufferSize` -

`sentinels` - Set the list of Sentinels.

`soLinger` -

`ssl` -

`tcpCork` -

`tcpFastOpen` -

`tcpKeepAlive` -

`tcpNoDelay` -

`tcpQuickAck` -

`trafficClass` -

`trustAll` -

`trustStoreOptions` -

`useAlpn` -

`usePooledBuffers` -