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 theoriginal
non Mutiny-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static TypeArg<DnsClient>
__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 oflookup4(String)
.DnsClient
lookup4AndForget(String name)
Variant oflookup4(String)
that ignores the result of the operation.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 oflookup6(String)
.DnsClient
lookup6AndForget(String name)
Variant oflookup6(String)
that ignores the result of the operation.String
lookupAndAwait(String name)
Blocking variant oflookup(String)
.DnsClient
lookupAndForget(String name)
Variant oflookup(String)
that ignores the result of the operation.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 ofresolveAAAA(String)
.DnsClient
resolveAAAAAndForget(String name)
Variant ofresolveAAAA(String)
that ignores the result of the operation.List<String>
resolveAAndAwait(String name)
Blocking variant ofresolveA(String)
.DnsClient
resolveAAndForget(String name)
Variant ofresolveA(String)
that ignores the result of the operation.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 ofresolveCNAME(String)
.DnsClient
resolveCNAMEAndForget(String name)
Variant ofresolveCNAME(String)
that ignores the result of the operation.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 ofresolveMX(String)
.DnsClient
resolveMXAndForget(String name)
Variant ofresolveMX(String)
that ignores the result of the operation.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 ofresolveNS(String)
.DnsClient
resolveNSAndForget(String name)
Variant ofresolveNS(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
resolvePTR(String name)
Try to resolve the PTR record for the given name.String
resolvePTRAndAwait(String name)
Blocking variant ofresolvePTR(String)
.DnsClient
resolvePTRAndForget(String name)
Variant ofresolvePTR(String)
that ignores the result of the operation.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 ofresolveSRV(String)
.DnsClient
resolveSRVAndForget(String name)
Variant ofresolveSRV(String)
that ignores the result of the operation.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 ofresolveTXT(String)
.DnsClient
resolveTXTAndForget(String name)
Variant ofresolveTXT(String)
that ignores the result of the operation.io.smallrye.mutiny.Uni<String>
reverseLookup(String ipaddress)
Try to do a reverse lookup of an IP address.String
reverseLookupAndAwait(String ipaddress)
Blocking variant ofreverseLookup(String)
.DnsClient
reverseLookupAndForget(String ipaddress)
Variant ofreverseLookup(String)
that ignores the result of the operation.String
toString()
-
-
-
Constructor Detail
-
DnsClient
public DnsClient(io.vertx.core.dns.DnsClient delegate)
-
DnsClient
public DnsClient(Object delegate)
-
-
Method Detail
-
getDelegate
public io.vertx.core.dns.DnsClient getDelegate()
-
lookup
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
lookupAndAwait
public String lookupAndAwait(String name)
Blocking variant oflookup(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:
- the String instance produced by the operation.
-
lookupAndForget
public DnsClient lookupAndForget(String name)
Variant oflookup(String)
that ignores the result of the operation.This method subscribes on the result of
lookup(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlookup(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve- Returns:
- the instance of DnsClient to chain method calls.
-
lookup4
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
lookup4AndAwait
public String lookup4AndAwait(String name)
Blocking variant oflookup4(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:
- the String instance produced by the operation.
-
lookup4AndForget
public DnsClient lookup4AndForget(String name)
Variant oflookup4(String)
that ignores the result of the operation.This method subscribes on the result of
lookup4(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlookup4(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve- Returns:
- the instance of DnsClient to chain method calls.
-
lookup6
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
lookup6AndAwait
public String lookup6AndAwait(String name)
Blocking variant oflookup6(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:
- the String instance produced by the operation.
-
lookup6AndForget
public DnsClient lookup6AndForget(String name)
Variant oflookup6(String)
that ignores the result of the operation.This method subscribes on the result of
lookup6(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromlookup6(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve- Returns:
- the instance of DnsClient to chain method calls.
-
resolveA
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveAAndAwait
public List<String> resolveAAndAwait(String name)
Blocking variant ofresolveA(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:
- the List
instance produced by the operation.
-
resolveAAndForget
public DnsClient resolveAAndForget(String name)
Variant ofresolveA(String)
that ignores the result of the operation.This method subscribes on the result of
resolveA(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveA(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve- Returns:
- the instance of DnsClient to chain method calls.
-
resolveAAAA
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveAAAAAndAwait
public List<String> resolveAAAAAndAwait(String name)
Blocking variant ofresolveAAAA(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:
- the List
instance produced by the operation.
-
resolveAAAAAndForget
public DnsClient resolveAAAAAndForget(String name)
Variant ofresolveAAAA(String)
that ignores the result of the operation.This method subscribes on the result of
resolveAAAA(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveAAAA(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve- Returns:
- the instance of DnsClient to chain method calls.
-
resolveCNAME
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveCNAMEAndAwait
public List<String> resolveCNAMEAndAwait(String name)
Blocking variant ofresolveCNAME(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:
- the List
instance produced by the operation.
-
resolveCNAMEAndForget
public DnsClient resolveCNAMEAndForget(String name)
Variant ofresolveCNAME(String)
that ignores the result of the operation.This method subscribes on the result of
resolveCNAME(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveCNAME(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve the CNAME for- Returns:
- the instance of DnsClient to chain method calls.
-
resolveMX
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveMXAndAwait
public List<MxRecord> resolveMXAndAwait(String name)
Blocking variant ofresolveMX(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:
- the List
instance produced by the operation.
-
resolveMXAndForget
public DnsClient resolveMXAndForget(String name)
Variant ofresolveMX(String)
that ignores the result of the operation.This method subscribes on the result of
resolveMX(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveMX(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name for which the MX records should be resolved- Returns:
- the instance of DnsClient to chain method calls.
-
resolveTXT
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveTXTAndAwait
public List<String> resolveTXTAndAwait(String name)
Blocking variant ofresolveTXT(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:
- the List
instance produced by the operation.
-
resolveTXTAndForget
public DnsClient resolveTXTAndForget(String name)
Variant ofresolveTXT(String)
that ignores the result of the operation.This method subscribes on the result of
resolveTXT(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveTXT(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name for which the TXT records should be resolved- Returns:
- the instance of DnsClient to chain method calls.
-
resolvePTR
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolvePTRAndAwait
public String resolvePTRAndAwait(String name)
Blocking variant ofresolvePTR(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:
- the String instance produced by the operation.
-
resolvePTRAndForget
public DnsClient resolvePTRAndForget(String name)
Variant ofresolvePTR(String)
that ignores the result of the operation.This method subscribes on the result of
resolvePTR(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolvePTR(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name to resolve the PTR for- Returns:
- the instance of DnsClient to chain method calls.
-
resolveNS
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveNSAndAwait
public List<String> resolveNSAndAwait(String name)
Blocking variant ofresolveNS(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:
- the List
instance produced by the operation.
-
resolveNSAndForget
public DnsClient resolveNSAndForget(String name)
Variant ofresolveNS(String)
that ignores the result of the operation.This method subscribes on the result of
resolveNS(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveNS(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name for which the NS records should be resolved- Returns:
- the instance of DnsClient to chain method calls.
-
resolveSRV
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
resolveSRVAndAwait
public List<SrvRecord> resolveSRVAndAwait(String name)
Blocking variant ofresolveSRV(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:
- the List
instance produced by the operation.
-
resolveSRVAndForget
public DnsClient resolveSRVAndForget(String name)
Variant ofresolveSRV(String)
that ignores the result of the operation.This method subscribes on the result of
resolveSRV(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromresolveSRV(String)
but you don't need to compose it with other operations.- Parameters:
name
- the name for which the SRV records should be resolved- Returns:
- the instance of DnsClient to chain method calls.
-
reverseLookup
@CheckReturnValue 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:
- the
uni
firing the result of the operation when completed, or a failure if the operation failed.
-
reverseLookupAndAwait
public String reverseLookupAndAwait(String ipaddress)
Blocking variant ofreverseLookup(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:
- the String instance produced by the operation.
-
reverseLookupAndForget
public DnsClient reverseLookupAndForget(String ipaddress)
Variant ofreverseLookup(String)
that ignores the result of the operation.This method subscribes on the result of
reverseLookup(String)
, but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation fromreverseLookup(String)
but you don't need to compose it with other operations.- Parameters:
ipaddress
- the IP address to resolve the PTR for- Returns:
- the instance of DnsClient to chain method calls.
-
newInstance
public static DnsClient newInstance(io.vertx.core.dns.DnsClient arg)
-
-