io.vertx.kotlin.sqlclient.PoolOptions.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertx-lang-kotlin Show documentation
There is a newer version: 5.0.0.CR1
/*
 * 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.sqlclient

import io.vertx.sqlclient.PoolOptions
import java.util.concurrent.TimeUnit

/**
 * A function providing a DSL for building [io.vertx.sqlclient.PoolOptions] objects.
 *
 * The options for configuring a connection pool.
 *
 * @param connectionTimeout  Set the amount of time a client will wait for a connection from the pool. If the time is exceeded without a connection available, an exception is provided.
 * @param connectionTimeoutUnit  Set the time unit of [io.vertx.sqlclient.PoolOptions]
 * @param eventLoopSize  Set the number of event-loop the pool use.    when the size is 0, the client pool will use the current event-loop
   otherwise the client will create and use its own event loop
 
 The default size is 0.
 * @param idleTimeout  Establish an idle timeout for pooled connections, a value of zero disables the idle timeout.
 * @param idleTimeoutUnit  Establish an idle timeout unit for pooled connections.
 * @param maxLifetime  Establish a max lifetime for pooled connections, a value of zero disables the maximum lifetime.
 * @param maxLifetimeUnit  Establish a max lifetime unit for pooled connections.
 * @param maxSize  Set the maximum pool size
 * @param maxWaitQueueSize  Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in an failure.  If the value is set to a negative number then the queue will be unbounded.
 * @param name  Set the pool name, used when the pool shared, otherwise ignored.
 * @param poolCleanerPeriod  Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.
 * @param shared  Set to true to share the pool.  There can be multiple shared pools distinguished by [io.vertx.sqlclient.PoolOptions], when no specific name is set, the [io.vertx.sqlclient.PoolOptions] is used.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.sqlclient.PoolOptions original] using Vert.x codegen.
 */
fun poolOptionsOf(
  connectionTimeout: Int? = null,
  connectionTimeoutUnit: TimeUnit? = null,
  eventLoopSize: Int? = null,
  idleTimeout: Int? = null,
  idleTimeoutUnit: TimeUnit? = null,
  maxLifetime: Int? = null,
  maxLifetimeUnit: TimeUnit? = null,
  maxSize: Int? = null,
  maxWaitQueueSize: Int? = null,
  name: String? = null,
  poolCleanerPeriod: Int? = null,
  shared: Boolean? = null): PoolOptions = io.vertx.sqlclient.PoolOptions().apply {

  if (connectionTimeout != null) {
    this.setConnectionTimeout(connectionTimeout)
  }
  if (connectionTimeoutUnit != null) {
    this.setConnectionTimeoutUnit(connectionTimeoutUnit)
  }
  if (eventLoopSize != null) {
    this.setEventLoopSize(eventLoopSize)
  }
  if (idleTimeout != null) {
    this.setIdleTimeout(idleTimeout)
  }
  if (idleTimeoutUnit != null) {
    this.setIdleTimeoutUnit(idleTimeoutUnit)
  }
  if (maxLifetime != null) {
    this.setMaxLifetime(maxLifetime)
  }
  if (maxLifetimeUnit != null) {
    this.setMaxLifetimeUnit(maxLifetimeUnit)
  }
  if (maxSize != null) {
    this.setMaxSize(maxSize)
  }
  if (maxWaitQueueSize != null) {
    this.setMaxWaitQueueSize(maxWaitQueueSize)
  }
  if (name != null) {
    this.setName(name)
  }
  if (poolCleanerPeriod != null) {
    this.setPoolCleanerPeriod(poolCleanerPeriod)
  }
  if (shared != null) {
    this.setShared(shared)
  }
}