HttpClient::Timeout Property

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the timespan to wait before the request times out.

Namespace:   System.Net.Http
Assembly:  System.Net.Http (in System.Net.Http.dll)

public:
property TimeSpan Timeout {
	TimeSpan get();
	void set(TimeSpan value);
}

Property Value

Type: System::TimeSpan

The timespan to wait before the request times out.

Exception Condition
ArgumentOutOfRangeException

The timeout specified is less than or equal to zero and is not InfiniteTimeSpan.

InvalidOperationException

An operation has already been started on the current instance.

ObjectDisposedException

The current instance has been disposed.

The default value is 100,000 milliseconds (100 seconds).

To set an infinite timeout, set the property value to InfiniteTimeSpan.

A Domain Name System (DNS) query may take up to 15 seconds to return or time out. If your request contains a host name that requires resolution and you set Timeout to a value less than 15 seconds, it may take 15 seconds or more before a WebException is thrown to indicate a timeout on your request.

The same timeout will apply for all requests using this HttpClient instance. You may also set different timeouts for individual requests using a CancellationTokenSource on a task. Note that only the shorter of the two timeouts will apply.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: