Package io.vertx.mutiny.core.dns

Class DnsClient

java.lang.Object

io.vertx.mutiny.core.dns.DnsClient

public class DnsClient
extends Object

Provides a way to asynchronously lookup information from DNS servers.

Please consult the documentation for more information on DNS clients.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

Field Summary

Fields

Modifier and Type	Field	Description
static TypeArg<DnsClient>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
DnsClient(io.vertx.core.dns.DnsClient delegate)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
io.vertx.core.dns.DnsClient	getDelegate()
int	hashCode()
io.smallrye.mutiny.Uni<String>	lookup(String name)	Try to lookup the A (ipv4) or AAAA (ipv6) record for the given name.
io.smallrye.mutiny.Uni<String>	lookup4(String name)	Try to lookup the A (ipv4) record for the given name.
String	lookup4AndAwait(String name)	Blocking variant of lookup4(String).
io.smallrye.mutiny.Uni<String>	lookup6(String name)	Try to lookup the AAAA (ipv6) record for the given name.
String	lookup6AndAwait(String name)	Blocking variant of lookup6(String).
String	lookupAndAwait(String name)	Blocking variant of lookup(String).
static DnsClient	newInstance(io.vertx.core.dns.DnsClient arg)
io.smallrye.mutiny.Uni<List<String>>	resolveA(String name)	Try to resolve all A (ipv4) records for the given name.
io.smallrye.mutiny.Uni<List<String>>	resolveAAAA(String name)	Try to resolve all AAAA (ipv6) records for the given name.
List<String>	resolveAAAAAndAwait(String name)	Blocking variant of resolveAAAA(String).
List<String>	resolveAAndAwait(String name)	Blocking variant of resolveA(String).
io.smallrye.mutiny.Uni<List<String>>	resolveCNAME(String name)	Try to resolve the CNAME record for the given name.
List<String>	resolveCNAMEAndAwait(String name)	Blocking variant of resolveCNAME(String).
io.smallrye.mutiny.Uni<List<MxRecord>>	resolveMX(String name)	Try to resolve the MX records for the given name.
List<MxRecord>	resolveMXAndAwait(String name)	Blocking variant of resolveMX(String).
io.smallrye.mutiny.Uni<List<String>>	resolveNS(String name)	Try to resolve the NS records for the given name.
List<String>	resolveNSAndAwait(String name)	Blocking variant of resolveNS(String).
io.smallrye.mutiny.Uni<String>	resolvePTR(String name)	Try to resolve the PTR record for the given name.
String	resolvePTRAndAwait(String name)	Blocking variant of resolvePTR(String).
io.smallrye.mutiny.Uni<List<SrvRecord>>	resolveSRV(String name)	Try to resolve the SRV records for the given name.
List<SrvRecord>	resolveSRVAndAwait(String name)	Blocking variant of resolveSRV(String).
io.smallrye.mutiny.Uni<List<String>>	resolveTXT(String name)	Try to resolve the TXT records for the given name.
List<String>	resolveTXTAndAwait(String name)	Blocking variant of resolveTXT(String).
io.smallrye.mutiny.Uni<String>	reverseLookup(String ipaddress)	Try to do a reverse lookup of an IP address.
String	reverseLookupAndAwait(String ipaddress)	Blocking variant of reverseLookup(String).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

__TYPE_ARG

public static final TypeArg<DnsClient> __TYPE_ARG

Constructor Detail

DnsClient

public DnsClient(io.vertx.core.dns.DnsClient delegate)

Method Detail

getDelegate

public io.vertx.core.dns.DnsClient getDelegate()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

lookup

public io.smallrye.mutiny.Uni<String> lookup(String name)

Try to lookup the A (ipv4) or AAAA (ipv6) record for the given name. The first found will be used.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

lookupAndAwait

public String lookupAndAwait(String name)

Blocking variant of lookup(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

lookup4

public io.smallrye.mutiny.Uni<String> lookup4(String name)

Try to lookup the A (ipv4) record for the given name. The first found will be used.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

lookup4AndAwait

public String lookup4AndAwait(String name)

Blocking variant of lookup4(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

lookup6

public io.smallrye.mutiny.Uni<String> lookup6(String name)

Try to lookup the AAAA (ipv6) record for the given name. The first found will be used.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

lookup6AndAwait

public String lookup6AndAwait(String name)

Blocking variant of lookup6(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

resolveA

public io.smallrye.mutiny.Uni<List<String>> resolveA(String name)

Try to resolve all A (ipv4) records for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

resolveAAndAwait

public List<String> resolveAAndAwait(String name)

Blocking variant of resolveA(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

resolveAAAA

public io.smallrye.mutiny.Uni<List<String>> resolveAAAA(String name)

Try to resolve all AAAA (ipv6) records for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

resolveAAAAAndAwait

public List<String> resolveAAAAAndAwait(String name)

Blocking variant of resolveAAAA(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve

Returns:

a reference to this, so the API can be used fluently

resolveCNAME

public io.smallrye.mutiny.Uni<List<String>> resolveCNAME(String name)

Try to resolve the CNAME record for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve the CNAME for

Returns:

a reference to this, so the API can be used fluently.

resolveCNAMEAndAwait

public List<String> resolveCNAMEAndAwait(String name)

Blocking variant of resolveCNAME(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve the CNAME for

Returns:

a reference to this, so the API can be used fluently.

resolveMX

public io.smallrye.mutiny.Uni<List<MxRecord>> resolveMX(String name)

Try to resolve the MX records for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name for which the MX records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolveMXAndAwait

public List<MxRecord> resolveMXAndAwait(String name)

Blocking variant of resolveMX(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name for which the MX records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolveTXT

public io.smallrye.mutiny.Uni<List<String>> resolveTXT(String name)

Try to resolve the TXT records for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name for which the TXT records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolveTXTAndAwait

public List<String> resolveTXTAndAwait(String name)

Blocking variant of resolveTXT(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name for which the TXT records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolvePTR

public io.smallrye.mutiny.Uni<String> resolvePTR(String name)

Try to resolve the PTR record for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name to resolve the PTR for

Returns:

a reference to this, so the API can be used fluently.

resolvePTRAndAwait

public String resolvePTRAndAwait(String name)

Blocking variant of resolvePTR(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name to resolve the PTR for

Returns:

a reference to this, so the API can be used fluently.

resolveNS

public io.smallrye.mutiny.Uni<List<String>> resolveNS(String name)

Try to resolve the NS records for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name for which the NS records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolveNSAndAwait

public List<String> resolveNSAndAwait(String name)

Blocking variant of resolveNS(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name for which the NS records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolveSRV

public io.smallrye.mutiny.Uni<List<SrvRecord>> resolveSRV(String name)

Try to resolve the SRV records for the given name.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

name - the name for which the SRV records should be resolved

Returns:

a reference to this, so the API can be used fluently.

resolveSRVAndAwait

public List<SrvRecord> resolveSRVAndAwait(String name)

Blocking variant of resolveSRV(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

name - the name for which the SRV records should be resolved

Returns:

a reference to this, so the API can be used fluently.

reverseLookup

public io.smallrye.mutiny.Uni<String> reverseLookup(String ipaddress)

Try to do a reverse lookup of an IP address. This is basically the same as doing trying to resolve a PTR record but allows you to just pass in the IP address and not a valid ptr query string.

Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

Parameters:

ipaddress - the IP address to resolve the PTR for

Returns:

a reference to this, so the API can be used fluently.

reverseLookupAndAwait

public String reverseLookupAndAwait(String ipaddress)

Blocking variant of reverseLookup(String).

This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

Parameters:

ipaddress - the IP address to resolve the PTR for

Returns:

a reference to this, so the API can be used fluently.

newInstance

public static DnsClient newInstance(io.vertx.core.dns.DnsClient arg)