Luciad.Net.Http.IHttpClient Interface Reference

Interface for sending HTTP requests. More...

Inheritance diagram for Luciad.Net.Http.IHttpClient:

Public Member Functions
Luciad.Net.Http.HttpResponse	Send (Luciad.Net.Http.HttpRequest request, Luciad.Concurrent.CancellationToken token)
	Returns the HTTP response for the given HTTP request. More...

Detailed Description

Interface for sending HTTP requests.

Implementations of this interface must be thread-safe. See also the related guide on How to customize HTTP requests when loading data. 2023.0

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::IHttpClient.

Member Function Documentation

Send()

Luciad.Net.Http.HttpResponse Luciad.Net.Http.IHttpClient.Send	(	Luciad.Net.Http.HttpRequest	request,
		Luciad.Concurrent.CancellationToken	token
	)

Returns the HTTP response for the given HTTP request.

This method is synchronous and blocks until the request has been sent and the response has been received. The request process can be canceled by the means of the cancellation token. It is up to the implementer to verify that the cancellation token state is set to true during the operation. When set to true this indicates that a HTTP response is no longer needed. The return value then can be an ErrorInfo object with the error code Canceled.

request

HTTP request.

token

Cancellation token.

the HTTP response.

luciad::IOException

when loading the data fails.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::IHttpClient::send.

Implemented in Luciad.Net.Http.HttpClient.