io.vertx.kotlin.core.dns.AddressResolverOptions.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.AddressResolverOptions
import io.vertx.core.buffer.Buffer

/**
 * A function providing a DSL for building [io.vertx.core.dns.AddressResolverOptions] objects.
 *
 * Configuration options for Vert.x hostname resolver. The resolver uses the local hosts file and performs
 * DNS A and AAAA queries.
 *
 * @param hostsPath  Set the path of an alternate hosts configuration file to use instead of the one provided by the os.  The default value is null, so the operating system hosts config is used.
 * @param hostsValue  Set an alternate hosts configuration file to use instead of the one provided by the os. 
 The value should contain the hosts content literaly, for instance 127.0.0.1 localhost 
 The default value is null, so the operating system hosts config is used.
 * @param hostsRefreshPeriod  Set the hosts configuration refresh period in millis, 0 disables it. 
 The resolver caches the hosts configuration [io.vertx.core.dns.AddressResolverOptions] after it has read it. When the content of this file can change, setting a positive refresh period will load the configuration file again when necessary.
 * @param servers  Set the list of DNS server addresses, an address is the IP  of the dns server, followed by an optional colon and a port, e.g 8.8.8.8 or {code 192.168.0.1:40000}. When the list is empty, the resolver will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved it will use Google's public DNS servers "8.8.8.8" and "8.8.4.4".
 * @param optResourceEnabled  Set to true to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.
 * @param cacheMinTimeToLive  Set the cache minimum TTL value in seconds. After resolution successful IP addresses are cached with their DNS response TTL, use this to set a minimum value to all responses TTL.
 * @param cacheMaxTimeToLive  Set the cache maximum TTL value in seconds. After successful resolution IP addresses are cached with their DNS response TTL, use this to set a maximum value to all responses TTL.
 * @param cacheNegativeTimeToLive  Set the negative cache TTL value in seconds. After a failed hostname resolution, DNS queries won't be retried for a period of time equals to the negative TTL. This allows to reduce the response time of negative replies and reduce the amount of messages to DNS servers.
 * @param queryTimeout  Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.
 * @param maxQueries  Set the maximum number of queries when an hostname is resolved.
 * @param rdFlag  Set the DNS queries Recursion Desired flag value.
 * @param searchDomains  Set the lists of DNS search domains. 
 When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.
 * @param ndots  Set the ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.
 * @param rotateServers  Set to true to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.
 * @param roundRobinInetAddress  Set to true to enable round-robin inet address selection of the ip address to use.
 *
 * 
 * NOTE: This function has been automatically generated from the [io.vertx.core.dns.AddressResolverOptions original] using Vert.x codegen.
 */
fun addressResolverOptionsOf(
  hostsPath: String? = null,
  hostsValue: io.vertx.core.buffer.Buffer? = null,
  hostsRefreshPeriod: Int? = null,
  servers: Iterable? = null,
  optResourceEnabled: Boolean? = null,
  cacheMinTimeToLive: Int? = null,
  cacheMaxTimeToLive: Int? = null,
  cacheNegativeTimeToLive: Int? = null,
  queryTimeout: Long? = null,
  maxQueries: Int? = null,
  rdFlag: Boolean? = null,
  searchDomains: Iterable? = null,
  ndots: Int? = null,
  rotateServers: Boolean? = null,
  roundRobinInetAddress: Boolean? = null): AddressResolverOptions = io.vertx.core.dns.AddressResolverOptions().apply {

  if (hostsPath != null) {
    this.setHostsPath(hostsPath)
  }
  if (hostsValue != null) {
    this.setHostsValue(hostsValue)
  }
  if (hostsRefreshPeriod != null) {
    this.setHostsRefreshPeriod(hostsRefreshPeriod)
  }
  if (servers != null) {
    this.setServers(servers.toList())
  }
  if (optResourceEnabled != null) {
    this.setOptResourceEnabled(optResourceEnabled)
  }
  if (cacheMinTimeToLive != null) {
    this.setCacheMinTimeToLive(cacheMinTimeToLive)
  }
  if (cacheMaxTimeToLive != null) {
    this.setCacheMaxTimeToLive(cacheMaxTimeToLive)
  }
  if (cacheNegativeTimeToLive != null) {
    this.setCacheNegativeTimeToLive(cacheNegativeTimeToLive)
  }
  if (queryTimeout != null) {
    this.setQueryTimeout(queryTimeout)
  }
  if (maxQueries != null) {
    this.setMaxQueries(maxQueries)
  }
  if (rdFlag != null) {
    this.setRdFlag(rdFlag)
  }
  if (searchDomains != null) {
    this.setSearchDomains(searchDomains.toList())
  }
  if (ndots != null) {
    this.setNdots(ndots)
  }
  if (rotateServers != null) {
    this.setRotateServers(rotateServers)
  }
  if (roundRobinInetAddress != null) {
    this.setRoundRobinInetAddress(roundRobinInetAddress)
  }
}