io.vertx.kotlin.core.dns.AddressResolverOptions.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.core.dns
import io.vertx.core.dns.AddressResolverOptions
/**
* 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 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 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 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 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 maxQueries Set the maximum number of queries when an hostname is resolved.
* @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 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 queryTimeout Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.
* @param rdFlag Set the DNS queries Recursion Desired flag value.
* @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.
* @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 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".
*
*
* NOTE: This function has been automatically generated from the [io.vertx.core.dns.AddressResolverOptions original] using Vert.x codegen.
*/
fun addressResolverOptionsOf(
cacheMaxTimeToLive: Int? = null,
cacheMinTimeToLive: Int? = null,
cacheNegativeTimeToLive: Int? = null,
hostsPath: String? = null,
hostsValue: io.vertx.core.buffer.Buffer? = null,
maxQueries: Int? = null,
ndots: Int? = null,
optResourceEnabled: Boolean? = null,
queryTimeout: Long? = null,
rdFlag: Boolean? = null,
rotateServers: Boolean? = null,
roundRobinInetAddress: Boolean? = null,
searchDomains: Iterable? = null,
servers: Iterable? = null): AddressResolverOptions = io.vertx.core.dns.AddressResolverOptions().apply {
if (cacheMaxTimeToLive != null) {
this.setCacheMaxTimeToLive(cacheMaxTimeToLive)
}
if (cacheMinTimeToLive != null) {
this.setCacheMinTimeToLive(cacheMinTimeToLive)
}
if (cacheNegativeTimeToLive != null) {
this.setCacheNegativeTimeToLive(cacheNegativeTimeToLive)
}
if (hostsPath != null) {
this.setHostsPath(hostsPath)
}
if (hostsValue != null) {
this.setHostsValue(hostsValue)
}
if (maxQueries != null) {
this.setMaxQueries(maxQueries)
}
if (ndots != null) {
this.setNdots(ndots)
}
if (optResourceEnabled != null) {
this.setOptResourceEnabled(optResourceEnabled)
}
if (queryTimeout != null) {
this.setQueryTimeout(queryTimeout)
}
if (rdFlag != null) {
this.setRdFlag(rdFlag)
}
if (rotateServers != null) {
this.setRotateServers(rotateServers)
}
if (roundRobinInetAddress != null) {
this.setRoundRobinInetAddress(roundRobinInetAddress)
}
if (searchDomains != null) {
this.setSearchDomains(searchDomains.toList())
}
if (servers != null) {
this.setServers(servers.toList())
}
}
/**
* 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 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 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 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 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 maxQueries Set the maximum number of queries when an hostname is resolved.
* @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 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 queryTimeout Set the query timeout in milliseconds, i.e the amount of time after a query is considered to be failed.
* @param rdFlag Set the DNS queries Recursion Desired flag value.
* @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.
* @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 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".
*
*
* NOTE: This function has been automatically generated from the [io.vertx.core.dns.AddressResolverOptions original] using Vert.x codegen.
*/
@Deprecated(
message = "This function will be removed in a future version",
replaceWith = ReplaceWith("addressResolverOptionsOf(cacheMaxTimeToLive, cacheMinTimeToLive, cacheNegativeTimeToLive, hostsPath, hostsValue, maxQueries, ndots, optResourceEnabled, queryTimeout, rdFlag, rotateServers, roundRobinInetAddress, searchDomains, servers)")
)
fun AddressResolverOptions(
cacheMaxTimeToLive: Int? = null,
cacheMinTimeToLive: Int? = null,
cacheNegativeTimeToLive: Int? = null,
hostsPath: String? = null,
hostsValue: io.vertx.core.buffer.Buffer? = null,
maxQueries: Int? = null,
ndots: Int? = null,
optResourceEnabled: Boolean? = null,
queryTimeout: Long? = null,
rdFlag: Boolean? = null,
rotateServers: Boolean? = null,
roundRobinInetAddress: Boolean? = null,
searchDomains: Iterable? = null,
servers: Iterable? = null): AddressResolverOptions = io.vertx.core.dns.AddressResolverOptions().apply {
if (cacheMaxTimeToLive != null) {
this.setCacheMaxTimeToLive(cacheMaxTimeToLive)
}
if (cacheMinTimeToLive != null) {
this.setCacheMinTimeToLive(cacheMinTimeToLive)
}
if (cacheNegativeTimeToLive != null) {
this.setCacheNegativeTimeToLive(cacheNegativeTimeToLive)
}
if (hostsPath != null) {
this.setHostsPath(hostsPath)
}
if (hostsValue != null) {
this.setHostsValue(hostsValue)
}
if (maxQueries != null) {
this.setMaxQueries(maxQueries)
}
if (ndots != null) {
this.setNdots(ndots)
}
if (optResourceEnabled != null) {
this.setOptResourceEnabled(optResourceEnabled)
}
if (queryTimeout != null) {
this.setQueryTimeout(queryTimeout)
}
if (rdFlag != null) {
this.setRdFlag(rdFlag)
}
if (rotateServers != null) {
this.setRotateServers(rotateServers)
}
if (roundRobinInetAddress != null) {
this.setRoundRobinInetAddress(roundRobinInetAddress)
}
if (searchDomains != null) {
this.setSearchDomains(searchDomains.toList())
}
if (servers != null) {
this.setServers(servers.toList())
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy