io.vertx.kotlin.core.dns.DnsClientOptions.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.core.dns

import io.vertx.core.dns.DnsClientOptions

/**
 * A function providing a DSL for building [io.vertx.core.dns.DnsClientOptions] objects.
 *
 * Configuration options for Vert.x DNS client.
 *
 * @param host  Set the host name to be used by this client in requests.
 * @param logActivity  Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
 * @param port  Set the port to be used by this client in requests.
 * @param queryTimeout  Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.
 * @param recursionDesired  Set whether or not recursion is desired
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.core.dns.DnsClientOptions original] using Vert.x codegen.
 */
fun dnsClientOptionsOf(
  host: String? = null,
  logActivity: Boolean? = null,
  port: Int? = null,
  queryTimeout: Long? = null,
  recursionDesired: Boolean? = null): DnsClientOptions = io.vertx.core.dns.DnsClientOptions().apply {

  if (host != null) {
    this.setHost(host)
  }
  if (logActivity != null) {
    this.setLogActivity(logActivity)
  }
  if (port != null) {
    this.setPort(port)
  }
  if (queryTimeout != null) {
    this.setQueryTimeout(queryTimeout)
  }
  if (recursionDesired != null) {
    this.setRecursionDesired(recursionDesired)
  }
}

/**
 * A function providing a DSL for building [io.vertx.core.dns.DnsClientOptions] objects.
 *
 * Configuration options for Vert.x DNS client.
 *
 * @param host  Set the host name to be used by this client in requests.
 * @param logActivity  Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
 * @param port  Set the port to be used by this client in requests.
 * @param queryTimeout  Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.
 * @param recursionDesired  Set whether or not recursion is desired
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.core.dns.DnsClientOptions original] using Vert.x codegen.
 */
@Deprecated(
  message = "This function will be removed in a future version",
  replaceWith = ReplaceWith("dnsClientOptionsOf(host, logActivity, port, queryTimeout, recursionDesired)")
)
fun DnsClientOptions(
  host: String? = null,
  logActivity: Boolean? = null,
  port: Int? = null,
  queryTimeout: Long? = null,
  recursionDesired: Boolean? = null): DnsClientOptions = io.vertx.core.dns.DnsClientOptions().apply {

  if (host != null) {
    this.setHost(host)
  }
  if (logActivity != null) {
    this.setLogActivity(logActivity)
  }
  if (port != null) {
    this.setPort(port)
  }
  if (queryTimeout != null) {
    this.setQueryTimeout(queryTimeout)
  }
  if (recursionDesired != null) {
    this.setRecursionDesired(recursionDesired)
  }
}