Class DotNetHttpClient

An implementation of IHttpClient for .Net specific applications

Inheritance

Object

DotNetHttpClient

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Cloud.Common

Syntax

public class DotNetHttpClient : IHttpClient, IDisposable

Constructors

DotNetHttpClient()

Initializes and returns an instance of DotNetHttpClient.

Declaration

public DotNetHttpClient()

Properties

Timeout

The timespan to wait before the request times out.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

Implements

IHttpClient.Timeout

Methods

Dispose()

Ensure disposal of any IDisposable references.

Declaration

public void Dispose()

Implements

IDisposable.Dispose()

Dispose(Boolean)

Ensure internal disposal of any IDisposable references.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	Dispose pattern boolean value received from public Dispose method.

DownloadFileAsync(HttpRequestMessage, String, CancellationToken)

Send an asynchronous file download request.

Declaration

public Task<HttpResponseMessage> DownloadFileAsync(HttpRequestMessage request, string downloadFilePath, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
HttpRequestMessage	request	The request to be sent.
String	downloadFilePath	Optional path to save downloaded files.
CancellationToken	cancellationToken	Optional cancellation token that will try to cancel the operation.

Returns

Type	Description
Task<HttpResponseMessage>	A task that will hold the HttpResponseMessage once the request is completed

Implements

IHttpClient.DownloadFileAsync(HttpRequestMessage, String, CancellationToken)

SendAsync(HttpRequestMessage, CancellationToken)

Send an asynchronous HTTP request.

Declaration

public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken = default(CancellationToken))

Parameters

Type	Name	Description
HttpRequestMessage	request	The request to be sent.
CancellationToken	cancellationToken	Optional cancellation token that will try to cancel the operation.

Returns

Type	Description
Task<HttpResponseMessage>	A task that will hold the HttpResponseMessage once the request is completed

Implements

IHttpClient.SendAsync(HttpRequestMessage, CancellationToken)

Exceptions

Type	Condition
ArgumentNullException	Thrown when the request is null.
HttpRequestException	Thrown when an HTTP response can't be obtained from the server.
OperationCanceledException	Thrown when the request is cancelled by a cancellation token.
TimeoutException	Thrown when the request failed due to timeout.