Class ServiceHttpClient

An implementation of an HTTP client which abstracts the Task of sending HttpRequestMessage.

Inheritance

Object

ServiceHttpClient

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 ServiceHttpClient : IServiceHttpClient, IHttpClient

Constructors

ServiceHttpClient(IHttpClient, IAccessTokenProvider, IAppIdProvider)

Initializes and returns an instance of ServiceHttpClient

Declaration

public ServiceHttpClient(IHttpClient baseHttpClient, IAccessTokenProvider accessTokenProvider, IAppIdProvider appIdProvider)

Parameters

Type	Name	Description
IHttpClient	baseHttpClient	The base HTTP client.
IAccessTokenProvider	accessTokenProvider	The access token provider to authenticate requests.
IAppIdProvider	appIdProvider	The App ID provider.

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

SendAsync(HttpRequestMessage, HttpCompletionOption, IProgress<HttpProgress>, CancellationToken)

Sends an asynchronous HTTP request.

Declaration

public Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, HttpCompletionOption completionOption, IProgress<HttpProgress> progress, CancellationToken cancellationToken)

Parameters

Type	Name	Description
HttpRequestMessage	request	The request to be sent.
HttpCompletionOption	completionOption	When the operation should complete.
IProgress<HttpProgress>	progress	The progress provider.
CancellationToken	cancellationToken	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, HttpCompletionOption, IProgress<HttpProgress>, 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.

SendAsync(HttpRequestMessage, ServiceHttpClientOptions, IProgress<HttpProgress>, CancellationToken)

Declaration

public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, ServiceHttpClientOptions options, IProgress<HttpProgress> progress, CancellationToken cancellationToken)

Parameters

Type	Name	Description
HttpRequestMessage	request
ServiceHttpClientOptions	options
IProgress<HttpProgress>	progress
CancellationToken	cancellationToken

Returns

Type	Description
Task<HttpResponseMessage>

SendAsync(HttpRequestMessage, ServiceHttpClientOptions, HttpCompletionOption, IProgress<HttpProgress>, CancellationToken)

Send an asynchronous HTTP request.

Declaration

public async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, ServiceHttpClientOptions options, HttpCompletionOption completionOption, IProgress<HttpProgress> progress, CancellationToken cancellationToken)

Parameters

Type	Name	Description
HttpRequestMessage	request	The request to be sent.
ServiceHttpClientOptions	options	The options for the client.
HttpCompletionOption	completionOption	When the operation should complete.
IProgress<HttpProgress>	progress	The progress provider.
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

IServiceHttpClient.SendAsync(HttpRequestMessage, ServiceHttpClientOptions, HttpCompletionOption, IProgress<HttpProgress>, 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.