DnsOptions.Builder


public static final class DnsOptions.Builder
extends Object

java.lang.Object
   ↳ android.net.http.DnsOptions.Builder


Builder for DnsOptions.

Summary

Public constructors

Builder()

Public methods

DnsOptions build()

Creates and returns the final DnsOptions instance, based on the values in this builder.

DnsOptions.Builder setPersistHostCache(int state)

Sets whether the DNS cache should be persisted to disk.

DnsOptions.Builder setPersistHostCachePeriod(Duration persistHostCachePeriod)

Sets the minimum period between subsequent writes to disk for DNS cache persistence.

DnsOptions.Builder setPreestablishConnectionsToStaleDnsResults(int state)

Sets whether Cronet should use stale cached DNS records to pre-establish connections.

DnsOptions.Builder setStaleDns(int state)

Sets whether to use stale DNS results at all.

DnsOptions.Builder setStaleDnsOptions(DnsOptions.StaleDnsOptions staleDnsOptions)

Sets detailed configuration for stale DNS.

DnsOptions.Builder setUseHttpStackDnsResolver(int state)

Enables the use of the HTTP-stack-specific DNS resolver.

Inherited methods

Public constructors

Builder

Added in API level 34
Also in S Extensions 7
public Builder ()

Public methods

build

Added in API level 34
Also in S Extensions 7
public DnsOptions build ()

Creates and returns the final DnsOptions instance, based on the values in this builder.

Returns
DnsOptions This value cannot be null.

setPersistHostCache

Added in API level 34
Also in S Extensions 7
public DnsOptions.Builder setPersistHostCache (int state)

Sets whether the DNS cache should be persisted to disk.

Only relevant if HttpEngine.Builder#setStoragePath(String) is set.

Parameters
state int: one of the DNS_OPTION_* values Value is DnsOptions.DNS_OPTION_UNSPECIFIED, DnsOptions.DNS_OPTION_ENABLED, or DnsOptions.DNS_OPTION_DISABLED

Returns
DnsOptions.Builder the builder for chaining This value cannot be null.

setPersistHostCachePeriod

Added in API level 34
Also in S Extensions 7
public DnsOptions.Builder setPersistHostCachePeriod (Duration persistHostCachePeriod)

Sets the minimum period between subsequent writes to disk for DNS cache persistence.

Only relevant if setPersistHostCache(int) is set to DnsOptions.DNS_OPTION_ENABLED.

Parameters
persistHostCachePeriod Duration: This value cannot be null.

Returns
DnsOptions.Builder the builder for chaining This value cannot be null.

setPreestablishConnectionsToStaleDnsResults

Added in API level 34
Also in S Extensions 7
public DnsOptions.Builder setPreestablishConnectionsToStaleDnsResults (int state)

Sets whether Cronet should use stale cached DNS records to pre-establish connections.

If enabled, Cronet will optimistically pre-establish connections to servers that matched the hostname at some point in the past and were cached but the cache entry expired. Such connections won't be used further until a new DNS lookup confirms the cached record was up to date.

To use cached DNS records straight away, use setStaleDns(int) and StaleDnsOptions configuration options.

This option may not be available for all networking protocols.

Parameters
state int: one of the DNS_OPTION_* values Value is DnsOptions.DNS_OPTION_UNSPECIFIED, DnsOptions.DNS_OPTION_ENABLED, or DnsOptions.DNS_OPTION_DISABLED

Returns
DnsOptions.Builder the builder for chaining This value cannot be null.

setStaleDns

Added in API level 34
Also in S Extensions 7
public DnsOptions.Builder setStaleDns (int state)

Sets whether to use stale DNS results at all.

Parameters
state int: one of the DNS_OPTION_* values Value is DnsOptions.DNS_OPTION_UNSPECIFIED, DnsOptions.DNS_OPTION_ENABLED, or DnsOptions.DNS_OPTION_DISABLED

Returns
DnsOptions.Builder the builder for chaining This value cannot be null.

setStaleDnsOptions

Added in API level 34
Also in S Extensions 7
public DnsOptions.Builder setStaleDnsOptions (DnsOptions.StaleDnsOptions staleDnsOptions)

Sets detailed configuration for stale DNS. Only relevant if setStaleDns(int) is set.

Parameters
staleDnsOptions DnsOptions.StaleDnsOptions: This value cannot be null.

Returns
DnsOptions.Builder this builder for chaining. This value cannot be null.

setUseHttpStackDnsResolver

Added in API level 34
Also in S Extensions 7
public DnsOptions.Builder setUseHttpStackDnsResolver (int state)

Enables the use of the HTTP-stack-specific DNS resolver.

Setting this to DnsOptions.DNS_OPTION_ENABLED is necessary for other functionality of DnsOptions to work, unless specified otherwise. See the DnsOptions documentation for more details.

Parameters
state int: one of the DNS_OPTION_* values Value is DnsOptions.DNS_OPTION_UNSPECIFIED, DnsOptions.DNS_OPTION_ENABLED, or DnsOptions.DNS_OPTION_DISABLED

Returns
DnsOptions.Builder the builder for chaining This value cannot be null.