HttpRequest

public bool AcceptGZip { get; set; }

Requests gzip/deflate when Accept-Encoding is unspecified and handles the corresponding response Content-Encoding. A decompressed-data bound is still necessary.

public bool AppendToDownloadFile { get; set; }

Allows appending on a suitable Partial Content response. Does not replace Range/Content-Range or existing-file identity checks.

public int BodySizeLimit { get; set; }

Body-byte bound; -1 disables it. Automatic decompression also bounds the decompressed result. Define an explicit budget for external responses.

public int DownloadChunkSize { get; set; }

The size of the buffer used and maximum bytes to read per iteration. See HttpClient.ReadChunkSize. Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to decrease memory usage at the cost of download speeds.

public string DownloadFile { get; set; }

Writes the response body to a path instead of signal body storage. Successful writing does not establish HTTP 2xx or valid content; use a temporary file first.

public bool KeepPartialDownload { get; set; }

Keeps an unfinished file when a request stops. A partial file is not a completed resource; validate length/content before use.

public int MaxRedirects { get; set; }

Automatic-redirect limit; 0 disallows them, -1 disables the limit. Validate destination, method and headers across redirects.

public double Timeout { get; set; }

Timeout in seconds; 0 disables it. The internal Timer ignores TimeScale, but its processing still depends on EntityTree/pause.

public bool UseThreads { get; set; }

Enables an internal worker if the build supports it. Does not automatically make your handlers or EntityTree access thread-safe.

public void CancelRequest();

Stops the active request; does not itself emit RequestCompleted for cancellation. File cleanup depends on completion and KeepPartialDownload.

public int GetBodySize();

Returns the response body length. Note: Some Web servers may not send a body length. In this case, the value returned will be -1. If using chunked transfer encoding, the body length will also be -1.

public int GetDownloadedBytes();

Returns the number of bytes this HTTPRequest downloaded.

public HttpClient.Status GetHttpClientStatus();

Returns the current status of the underlying HttpClient.

public Error Request(string url, ReadOnlySpan<string> customHeaders, HttpClient.Method method, string requestData);

Starts an HTTP request with a UTF-8 string body. Requires tree membership and an idle instance. Error.Ok does not mean an HTTP 2xx response arrived: inspect RequestCompleted.

public Error Request(string url, string[] customHeaders = null, HttpClient.Method method = HttpClient.Method.Get, string requestData = "");

Starts an HTTP request with a UTF-8 string body. Requires tree membership and an idle instance. Error.Ok does not mean an HTTP 2xx response arrived: inspect RequestCompleted.

public Error RequestRaw(string url, ReadOnlySpan<string> customHeaders, HttpClient.Method method, ReadOnlySpan<byte> requestDataRaw);

Sends exact body bytes. Match method and Content-Type to the API. Specify explicit array types if overload resolution is ambiguous.

public Error RequestRaw(string url, string[] customHeaders = null, HttpClient.Method method = HttpClient.Method.Get, byte[] requestDataRaw = null);

Sends exact body bytes. Match method and Content-Type to the API. Specify explicit array types if overload resolution is ambiguous.

public void SetHttpProxy(string host, int port);

Sets the proxy server for HTTP requests. The proxy server is unset if host is empty or port is -1.

public void SetHttpsProxy(string host, int port);

Sets the proxy server for HTTPS requests. The proxy server is unset if host is empty or port is -1.

public void SetTlsOptions(TlsOptions clientOptions);

Sets client options for HTTPS. Use verified Client options and load a private CA correctly before starting.

public event HttpRequest.RequestCompletedEventHandler RequestCompleted;

Reports transfer result, HTTP code, headers and body bytes. Result.Success can accompany 404. With DownloadFile the body goes to disk while body is empty.