Class HttpMessageHandlerBuilder

Namespace

Geotab.Checkmate.Web

Assembly

Geotab.Checkmate.ObjectModel.dll

The class that builds a HttpMessageHandler instance.

public sealed class HttpMessageHandlerBuilder

Inheritance

object

HttpMessageHandlerBuilder

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HttpMessageHandlerBuilder()

public HttpMessageHandlerBuilder()

Methods

Build()

Builds new instance of HttpMessageHandler.

public HttpMessageHandler Build()

Returns

HttpMessageHandler

The HttpMessageHandler.

UseAllowAutoRedirect(in bool)

Sets the AllowAutoRedirect value.

public HttpMessageHandlerBuilder UseAllowAutoRedirect(in bool value)

Parameters

value bool

The AllowAutoRedirect value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseAutomaticDecompression(in DecompressionMethods)

Sets the AutomaticDecompression value to DecompressionMethods.All.

public HttpMessageHandlerBuilder UseAutomaticDecompression(in DecompressionMethods value)

Parameters

value DecompressionMethods

The DecompressionMethods value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseCheckCertificateRevocationList(in bool)

Sets the CheckCertificateRevocationList value.

public HttpMessageHandlerBuilder UseCheckCertificateRevocationList(in bool value)

Parameters

value bool

The CheckCertificateRevocationList value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseClientCertificate(X509Certificate2)

Adds the X509Certificate2 value.

public HttpMessageHandlerBuilder UseClientCertificate(X509Certificate2 value)

Parameters

value X509Certificate2

The X509Certificate2 value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

Remarks

This certificate is ignored when a certificate callback is provided by UseClientCertificateCallback(Func<X509Certificate2>).

UseClientCertificateCallback(Func<X509Certificate2>)

Configures the client certificate callback using the specified Func<TResult> for X509Certificate2. This method allows deferred assignment of the client certificate through a callback function.

public HttpMessageHandlerBuilder UseClientCertificateCallback(Func<X509Certificate2> value)

Parameters

value Func<X509Certificate2>

The callback function that provides the X509Certificate2 value.

Returns

HttpMessageHandlerBuilder

The current HttpMessageHandlerBuilder instance, enabling method chaining.

Remarks

This certificate returned by the callback will supersede the one provided . UseClientCertificate(X509Certificate2) The callback will be executed for every HTTP request, unless the connection is reused, in which case the previously provided certificate will be used.

UseConnectTimeout(in TimeSpan)

Sets the connect timeout.

public HttpMessageHandlerBuilder UseConnectTimeout(in TimeSpan value)

Parameters

value TimeSpan

A TimeSpan indicating the connect timeout.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseCookies(in bool)

Sets the UseCookies value.

public HttpMessageHandlerBuilder UseCookies(in bool value)

Parameters

value bool

The UseCookies value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseCredentials(in NetworkCredential)

Sets the Credentials value.

public HttpMessageHandlerBuilder UseCredentials(in NetworkCredential value)

Parameters

value NetworkCredential

The Credentials value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseEnableMultipleHttp2Connections(in bool)

Sets a flag on the SocketsHttpHandler - based HttpMessageHandler that allows multiple HTTP2 connections to be established if all the streams in one are in use. Should be combined with UsePooledConnectionLifetime(in TimeSpan) to prune any extra connections.

public HttpMessageHandlerBuilder UseEnableMultipleHttp2Connections(in bool value)

Parameters

value bool

A boolean indicating if additional http2 connections should be allowed.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseMaxConnectionsPerServer(in int)

Sets the MaxConnectionsPerServer value.

public HttpMessageHandlerBuilder UseMaxConnectionsPerServer(in int value)

Parameters

value int

The MaxConnectionsPerServer value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UsePooledConnectionLifetime(in TimeSpan)

Sets the pooled connection lifetime of the SocketsHttpHandler - based HttpMessageHandler.

public HttpMessageHandlerBuilder UsePooledConnectionLifetime(in TimeSpan value)

Parameters

value TimeSpan

The pooled connection lifetime value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseProxy(in bool)

Sets the UseProxy value.

public HttpMessageHandlerBuilder UseProxy(in bool value)

Parameters

value bool

The UseProxy value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.

UseServerCertificateCustomValidationCallback(Func<object, X509Certificate2?, X509Chain?, SslPolicyErrors, bool>)

Sets the ServerCertificateCustomValidationCallback value.

public HttpMessageHandlerBuilder UseServerCertificateCustomValidationCallback(Func<object, X509Certificate2?, X509Chain?, SslPolicyErrors, bool> value)

Parameters

value Func<object, X509Certificate2, X509Chain, SslPolicyErrors, bool>

The ServerCertificateCustomValidationCallback value.

Returns

HttpMessageHandlerBuilder

The HttpMessageHandlerBuilder.