WebRequest.Timeout WebRequest.Timeout WebRequest.Timeout WebRequest.Timeout Property

Definition

Gets or sets the length of time, in milliseconds, before the request times out.

public:
 virtual property int Timeout { int get(); void set(int value); };
public virtual int Timeout { get; set; }
member this.Timeout : int with get, set
Public Overridable Property Timeout As Integer

Property Value

The length of time, in milliseconds, until the request times out, or the value Infinite to indicate that the request does not time out. The default value is defined by the descendant class.

Exceptions

Any attempt is made to get or set the property, when the property is not overridden in a descendant class.

Examples

The following example sets the Timeout property to 10000 milliseconds. If the timeout period expires before the resource can be returned, a WebException is thrown.

// Create a new WebRequest Object to the mentioned URL.
WebRequest^ myWebRequest = WebRequest::Create( "http://www.contoso.com" );
Console::WriteLine( "\nThe Timeout time of the request before setting is : {0} milliseconds", myWebRequest->Timeout );

// Set the 'Timeout' property in Milliseconds.
myWebRequest->Timeout = 10000;

// This request will throw a WebException if it reaches the timeout limit
// before it is able to fetch the resource.
WebResponse^ myWebResponse = myWebRequest->GetResponse();

                  // Create a new WebRequest Object to the mentioned URL.
WebRequest myWebRequest=WebRequest.Create("http://www.contoso.com");
Console.WriteLine("\nThe Timeout time of the request before setting is : {0} milliseconds",myWebRequest.Timeout);

// Set the 'Timeout' property in Milliseconds.
myWebRequest.Timeout=10000;

// This request will throw a WebException if it reaches the timeout limit before it is able to fetch the resource.
                  WebResponse myWebResponse=myWebRequest.GetResponse();


      ' Create a new WebRequest Object to the mentioned URL.
      Dim myWebRequest As WebRequest = WebRequest.Create("http://www.contoso.com")
      Console.WriteLine(ControlChars.Cr + "The Timeout time of the request before setting is : {0} milliseconds", myWebRequest.Timeout)

      ' Set the 'Timeout' property in Milliseconds.
myWebRequest.Timeout = 10000

     ' Assign the response object of 'WebRequest' to a 'WebResponse' variable.
      Dim myWebResponse As WebResponse = myWebRequest.GetResponse()

Remarks

The Timeout property indicates the length of time, in milliseconds, until the request times out and throws a WebException. The Timeout property affects only synchronous requests made with the GetResponse method. To time out asynchronous requests, use the Abort method.

Note

The WebRequest class is an abstract class. The actual behavior of WebRequest instances at run time is determined by the descendant class returned by the WebRequest.Create method. For more information about default values and exceptions, see the documentation for the descendant classes, such as HttpWebRequest and FileWebRequest.

Notes to Inheritors

Descendant classes signal a timeout by throwing a WebException with the Status field set to Timeout. When Timeout is set to Infinite the descendant class does not time out.

Applies to

See also