Setting Timeout

Sets the timeout duration for a single request.

HTTP Declarative Requests set the timeout through the TimeoutAttribute attribute. The corresponding HTTP declarative extractor is implemented by the TimeoutDeclarativeExtractor type, which is responsible for parsing the TimeoutAttribute attribute and building the timeout configuration required for the HttpRequestBuilder instance.

123456789101112

// Applied on the interface definition, affects all methods[Timeout(100_000)]  // 100 secondspublic interface IHttpService : IHttpDeclarative{    [Get("https://furion.net/")]    Task<string> GetStringAsync();    // Applied on the method    [Timeout(200_000)]   // 200 seconds    [Get("https://furion.net/")]    Task<string> GetStringAsync();}

HttpClient Timeout Notes

When setting a timeout on HttpClient, ensure that a single request's timeout does not exceed the timeout configured on HttpClient. For example, if the HttpClient timeout is set to 10 minutes while a single request's timeout is set to 15 minutes, the single request will still trigger a timeout exception once it exceeds 10 minutes. Sample code:

services.AddHttpClient(string.Empty, client =>{    client.Timeout = TimeSpan.FromMinutes(10); // The default timeout is 100 seconds and must be set explicitly});

Therefore, if a single request needs a longer timeout, make sure HttpClient's timeout is set correspondingly longer.

TimeoutAttribute contains the following constructors and properties:

Constructors:
- new(milliseconds): applies to a method or interface, sets the timeout.
Properties:
- Timeout: the timeout (in milliseconds) (double type).