Tgstation.Server.Common.Http.HttpClient Class Reference

More...

Inheritance diagram for Tgstation.Server.Common.Http.HttpClient:

Collaboration diagram for Tgstation.Server.Common.Http.HttpClient:

Public Member Functions
	HttpClient (System.Net.Http.HttpClient implementation)
	Initializes a new instance of the HttpClient class.
	HttpClient ()
	Initializes a new instance of the HttpClient class.
void	Dispose ()
Task< HttpResponseMessage >	SendAsync (HttpRequestMessage request, HttpCompletionOption completionOption, CancellationToken cancellationToken)
	Send an HTTP request. Parameters request The HttpRequestMessage. completionOption The HttpCompletionOption. cancellationToken The CancellationToken for the operation. Returns A Task<TResult> resulting in the HttpResponseMessage of the request.

Properties
TimeSpan	Timeout [get, set]
	The request timeout.
HttpRequestHeaders	DefaultRequestHeaders [get]
	The HttpRequestHeaders used on every request.
Properties inherited from Tgstation.Server.Common.Http.IHttpClient

Private Attributes
readonly System.Net.Http.HttpClient	httpClient
	The real System.Net.Http.HttpClient.

Detailed Description

Definition at line 10 of file HttpClient.cs.

Constructor & Destructor Documentation

HttpClient() [1/2]

Tgstation.Server.Common.Http.HttpClient.HttpClient

(

System::Net::Http::HttpClient

implementation

)

Initializes a new instance of the HttpClient class.

Parameters

implementation

The System.Net.Http.HttpClient to wrap.

Definition at line 31 of file HttpClient.cs.

        {
            httpClient = implementation ?? throw new ArgumentNullException(nameof(implementation));
        }

References Tgstation.Server.Common.Http.HttpClient.httpClient.

HttpClient() [2/2]

Tgstation.Server.Common.Http.HttpClient.HttpClient

(

)

Initializes a new instance of the HttpClient class.

Definition at line 39 of file HttpClient.cs.

            : this(new System.Net.Http.HttpClient())
        {
        }

Member Function Documentation

Dispose()

void Tgstation.Server.Common.Http.HttpClient.Dispose

(

)

SendAsync()

Task< HttpResponseMessage > Tgstation.Server.Common.Http.HttpClient.SendAsync	(	HttpRequestMessage	request,
		HttpCompletionOption	completionOption,
		CancellationToken	cancellationToken
	)

Send an HTTP request.

Parameters

request	The HttpRequestMessage.
completionOption	The HttpCompletionOption.
cancellationToken	The CancellationToken for the operation.

Returns

A Task<TResult> resulting in the HttpResponseMessage of the request.

Implements Tgstation.Server.Common.Http.IHttpClient.

Member Data Documentation

httpClient

readonly System.Net.Http.HttpClient Tgstation.Server.Common.Http.HttpClient.httpClient

private

The real System.Net.Http.HttpClient.

Definition at line 25 of file HttpClient.cs.

Referenced by Tgstation.Server.Common.Http.HttpClient.HttpClient().

Property Documentation

DefaultRequestHeaders

HttpRequestHeaders Tgstation.Server.Common.Http.HttpClient.DefaultRequestHeaders

get

The HttpRequestHeaders used on every request.

Implements Tgstation.Server.Common.Http.IHttpClient.

Definition at line 20 of file HttpClient.cs.

Referenced by Tgstation.Server.Host.Utils.AbstractHttpClientFactory.CreateClient().

Timeout

TimeSpan Tgstation.Server.Common.Http.HttpClient.Timeout

getset

The request timeout.

Implements Tgstation.Server.Common.Http.IHttpClient.

Definition at line 13 of file HttpClient.cs.

        {
            get => httpClient.Timeout;
            set => httpClient.Timeout = value;
        }

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Common/Http/HttpClient.cs