Domain Detective

API Reference

Class

ClientXBuilder

Edit on GitHub
Namespace DnsClientX
Assembly DnsClientX
Source DnsClientX/ClientXBuilder.cs:14

Builder class for creating configured ClientX instances.

Inheritance

  • Object
  • ClientXBuilder

Remarks

The fluent API allows step by step configuration of endpoints, timeouts and other options.

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Constructors

public ClientXBuilder() #
DnsClientX/ClientXBuilder.cs:14

Methods

public ClientX Build() #
DnsClientX/ClientXBuilder.cs:153
Returns: ClientX

Builds and returns a configured ClientX instance.

public ClientXBuilder WithBaseUri(Uri baseUri, DnsRequestFormat format) #
DnsClientX/ClientXBuilder.cs:124
Returns: ClientXBuilder

Configures a custom base URI and DNS request format.

Parameters

baseUri System.Uri requiredposition: 0
format DnsClientX.DnsRequestFormat requiredposition: 1
public ClientXBuilder WithEdnsOptions(EdnsOptions options) #
DnsClientX/ClientXBuilder.cs:135
Returns: ClientXBuilder

Configures EDNS options for DNS queries.

Parameters

options DnsClientX.EdnsOptions requiredposition: 0
The EDNS options to apply.
public ClientXBuilder WithEnableCache(Boolean enable = true) #
DnsClientX/ClientXBuilder.cs:98
Returns: ClientXBuilder

Enables or disables response caching.

Parameters

enable System.Boolean = true optionalposition: 0
public ClientXBuilder WithEndpoint(DnsEndpoint endpoint) #
DnsClientX/ClientXBuilder.cs:34
Returns: ClientXBuilder

Sets the DNS endpoint to use.

Parameters

endpoint DnsClientX.DnsEndpoint requiredposition: 0
Predefined DNS endpoint.
public ClientXBuilder WithHostname(String hostname, DnsRequestFormat format) #
DnsClientX/ClientXBuilder.cs:114
Returns: ClientXBuilder

Configures a custom hostname and DNS request format.

Parameters

hostname System.String requiredposition: 0
format DnsClientX.DnsRequestFormat requiredposition: 1
public ClientXBuilder WithHttpVersion(Version version) #
DnsClientX/ClientXBuilder.cs:82
Returns: ClientXBuilder

Sets the preferred HTTP version used for queries.

Parameters

version System.Version requiredposition: 0
public ClientXBuilder WithIgnoreCertificateErrors(Boolean ignore = true) #
DnsClientX/ClientXBuilder.cs:90
Returns: ClientXBuilder

Allows ignoring certificate validation errors.

Parameters

ignore System.Boolean = true optionalposition: 0
public ClientXBuilder WithProxy(IWebProxy proxy) #
DnsClientX/ClientXBuilder.cs:58
Returns: ClientXBuilder

Sets an optional web proxy for HTTP requests.

Parameters

proxy System.Net.IWebProxy requiredposition: 0
The web proxy to use.
public ClientXBuilder WithSelectionStrategy(DnsSelectionStrategy strategy) #
DnsClientX/ClientXBuilder.cs:66
Returns: ClientXBuilder

Sets the DNS server selection strategy.

Parameters

strategy DnsClientX.DnsSelectionStrategy requiredposition: 0
public ClientXBuilder WithSigningKey(AsymmetricAlgorithm key) #
DnsClientX/ClientXBuilder.cs:144
Returns: ClientXBuilder

Supplies a key used to sign DNS messages.

Parameters

key System.Security.Cryptography.AsymmetricAlgorithm requiredposition: 0
Asymmetric key pair.
public ClientXBuilder WithTimeout(Int32 timeout) #
DnsClientX/ClientXBuilder.cs:49
Returns: ClientXBuilder

Sets the DNS query timeout in milliseconds.

Parameters

timeout System.Int32 requiredposition: 0
Timeout in milliseconds.
public ClientXBuilder WithUserAgent(String userAgent) #
DnsClientX/ClientXBuilder.cs:74
Returns: ClientXBuilder

Sets the User-Agent header for HTTP requests.

Parameters

userAgent System.String requiredposition: 0
public ClientXBuilder WithUseTcpFallback(Boolean useTcpFallback) #
DnsClientX/ClientXBuilder.cs:106
Returns: ClientXBuilder

Configures TCP fallback behavior for UDP queries.

Parameters

useTcpFallback System.Boolean requiredposition: 0
{{ include "footer" }}