io.vertx.kotlin.redis.client.RedisOptions.kt Maven / Gradle / Ivy
/*
* Copyright 2019 Red Hat, Inc.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.kotlin.redis.client
import io.vertx.redis.client.RedisOptions
import io.vertx.core.net.NetClientOptions
import io.vertx.redis.client.RedisClientType
import io.vertx.redis.client.RedisRole
import io.vertx.redis.client.RedisSlaves
/**
* A function providing a DSL for building [io.vertx.redis.client.RedisOptions] objects.
*
* Redis Client Configuration options.
*
* @param connectionString Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings. Does not support rediss (redis over ssl scheme) for now.
* @param connectionStrings Adds a connection string (endpoint) to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.
Does not support rediss (redis over ssl scheme) for now.
* @param endpoint Sets a single connection string to use while connecting to the redis server. Will replace the previously configured connection strings.
* @param endpoints Set the endpoints to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.
* @param masterName Set the master name (only considered in HA mode).
* @param maxNestedArrays Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
* @param maxPoolSize Tune the maximum size of the connection pool. When working with cluster or sentinel this value should be atleast the total number of cluster member (or number of sentinels + 1)
* @param maxPoolWaiting Tune the maximum waiting requests for a connection from the pool.
* @param maxWaitingHandlers The client will always work on pipeline mode, this means that messages can start queueing. You can control how much backlog you're willing to accept. This methods sets how much handlers is the client willing to queue.
* @param netClientOptions Set the net client options to be used while connecting to the redis server. Use this to tune your connection.
* @param poolCleanerInterval Tune how often in milliseconds should the connection pool cleaner execute.
* @param poolRecycleTimeout Tune when a connection should be recycled in milliseconds.
* @param role Set the role name (only considered in HA mode).
* @param type Set the desired client type to be created.
* @param useSlave Set whether or not to use slave nodes (only considered in Cluster mode).
*
*
* NOTE: This function has been automatically generated from the [io.vertx.redis.client.RedisOptions original] using Vert.x codegen.
*/
fun redisOptionsOf(
connectionString: String? = null,
connectionStrings: Iterable? = null,
endpoint: String? = null,
endpoints: Iterable? = null,
masterName: String? = null,
maxNestedArrays: Int? = null,
maxPoolSize: Int? = null,
maxPoolWaiting: Int? = null,
maxWaitingHandlers: Int? = null,
netClientOptions: io.vertx.core.net.NetClientOptions? = null,
poolCleanerInterval: Int? = null,
poolRecycleTimeout: Int? = null,
role: RedisRole? = null,
type: RedisClientType? = null,
useSlave: RedisSlaves? = null): RedisOptions = io.vertx.redis.client.RedisOptions().apply {
if (connectionString != null) {
this.setConnectionString(connectionString)
}
if (connectionStrings != null) {
for (item in connectionStrings) {
this.addConnectionString(item)
}
}
if (endpoint != null) {
this.setEndpoint(endpoint)
}
if (endpoints != null) {
this.setEndpoints(endpoints.toList())
}
if (masterName != null) {
this.setMasterName(masterName)
}
if (maxNestedArrays != null) {
this.setMaxNestedArrays(maxNestedArrays)
}
if (maxPoolSize != null) {
this.setMaxPoolSize(maxPoolSize)
}
if (maxPoolWaiting != null) {
this.setMaxPoolWaiting(maxPoolWaiting)
}
if (maxWaitingHandlers != null) {
this.setMaxWaitingHandlers(maxWaitingHandlers)
}
if (netClientOptions != null) {
this.setNetClientOptions(netClientOptions)
}
if (poolCleanerInterval != null) {
this.setPoolCleanerInterval(poolCleanerInterval)
}
if (poolRecycleTimeout != null) {
this.setPoolRecycleTimeout(poolRecycleTimeout)
}
if (role != null) {
this.setRole(role)
}
if (type != null) {
this.setType(type)
}
if (useSlave != null) {
this.setUseSlave(useSlave)
}
}
/**
* A function providing a DSL for building [io.vertx.redis.client.RedisOptions] objects.
*
* Redis Client Configuration options.
*
* @param connectionString Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings. Does not support rediss (redis over ssl scheme) for now.
* @param connectionStrings Adds a connection string (endpoint) to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.
Does not support rediss (redis over ssl scheme) for now.
* @param endpoint Sets a single connection string to use while connecting to the redis server. Will replace the previously configured connection strings.
* @param endpoints Set the endpoints to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.
* @param masterName Set the master name (only considered in HA mode).
* @param maxNestedArrays Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
* @param maxPoolSize Tune the maximum size of the connection pool. When working with cluster or sentinel this value should be atleast the total number of cluster member (or number of sentinels + 1)
* @param maxPoolWaiting Tune the maximum waiting requests for a connection from the pool.
* @param maxWaitingHandlers The client will always work on pipeline mode, this means that messages can start queueing. You can control how much backlog you're willing to accept. This methods sets how much handlers is the client willing to queue.
* @param netClientOptions Set the net client options to be used while connecting to the redis server. Use this to tune your connection.
* @param poolCleanerInterval Tune how often in milliseconds should the connection pool cleaner execute.
* @param poolRecycleTimeout Tune when a connection should be recycled in milliseconds.
* @param role Set the role name (only considered in HA mode).
* @param type Set the desired client type to be created.
* @param useSlave Set whether or not to use slave nodes (only considered in Cluster mode).
*
*
* NOTE: This function has been automatically generated from the [io.vertx.redis.client.RedisOptions original] using Vert.x codegen.
*/
@Deprecated(
message = "This function will be removed in a future version",
replaceWith = ReplaceWith("redisOptionsOf(connectionString, connectionStrings, endpoint, endpoints, masterName, maxNestedArrays, maxPoolSize, maxPoolWaiting, maxWaitingHandlers, netClientOptions, poolCleanerInterval, poolRecycleTimeout, role, type, useSlave)")
)
fun RedisOptions(
connectionString: String? = null,
connectionStrings: Iterable? = null,
endpoint: String? = null,
endpoints: Iterable? = null,
masterName: String? = null,
maxNestedArrays: Int? = null,
maxPoolSize: Int? = null,
maxPoolWaiting: Int? = null,
maxWaitingHandlers: Int? = null,
netClientOptions: io.vertx.core.net.NetClientOptions? = null,
poolCleanerInterval: Int? = null,
poolRecycleTimeout: Int? = null,
role: RedisRole? = null,
type: RedisClientType? = null,
useSlave: RedisSlaves? = null): RedisOptions = io.vertx.redis.client.RedisOptions().apply {
if (connectionString != null) {
this.setConnectionString(connectionString)
}
if (connectionStrings != null) {
for (item in connectionStrings) {
this.addConnectionString(item)
}
}
if (endpoint != null) {
this.setEndpoint(endpoint)
}
if (endpoints != null) {
this.setEndpoints(endpoints.toList())
}
if (masterName != null) {
this.setMasterName(masterName)
}
if (maxNestedArrays != null) {
this.setMaxNestedArrays(maxNestedArrays)
}
if (maxPoolSize != null) {
this.setMaxPoolSize(maxPoolSize)
}
if (maxPoolWaiting != null) {
this.setMaxPoolWaiting(maxPoolWaiting)
}
if (maxWaitingHandlers != null) {
this.setMaxWaitingHandlers(maxWaitingHandlers)
}
if (netClientOptions != null) {
this.setNetClientOptions(netClientOptions)
}
if (poolCleanerInterval != null) {
this.setPoolCleanerInterval(poolCleanerInterval)
}
if (poolRecycleTimeout != null) {
this.setPoolRecycleTimeout(poolRecycleTimeout)
}
if (role != null) {
this.setRole(role)
}
if (type != null) {
this.setType(type)
}
if (useSlave != null) {
this.setUseSlave(useSlave)
}
}