WebRequest.Timeout プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

WebRequest.Timeout プロパティ

要求がタイムアウトするまでの時間を取得または設定します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Overridable Property
 Timeout As Integer

Visual Basic (使用法)

Dim instance As WebRequest
Dim value As Integer

value = instance.Timeout

instance.Timeout = value

public virtual int Timeout { get;
 set; }

C++

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

/** @property */
public int get_Timeout ()

/** @property */
public void set_Timeout (int
 value)

JScript

public function get Timeout
 () : int

public function set Timeout
 (value : int)

プロパティ値
要求がタイムアウトするまでのミリ秒単位の時間または要求がタイムアウトしないことを示す値 Timeout.Infinite。既定値は、派生クラスによって定義されます。

例外

例外の種類	条件
NotImplementedException	プロパティが派生クラスでオーバーライドされていないのに、そのプロパティの取得または設定が試行されました。

解説

Timeout プロパティは、要求がタイムアウトし、WebException をスローするまでのミリ秒単位の時間を指定します。Timeout プロパティは、GetResponse メソッドによる同期要求だけに適用されます。非同期要求をタイムアウトさせるには、Abort メソッドを使用します。

メモ
WebRequest クラスは、abstract クラスです。実行時の WebRequest インスタンスの実際の動作は、System.Net.WebRequest.Create メソッドで返される派生クラスによって決まります。既定値および例外の詳細については、HttpWebRequest や FileWebRequest などの派生クラスの説明を参照してください。

継承時の注意 派生クラスは、WebException をスローしてタイムアウトを通知し、Status フィールドを WebExceptionStatus.Timeout に設定します。Timeout が Timeout.Infinite に設定されている場合、派生クラスはタイムアウトしません。

使用例

Timeout プロパティを 10000 ミリ秒に設定する例を次に示します。リソースが返される前にタイムアウト時間が経過すると、WebException がスローされます。

Visual Basic

   ' 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()

         // 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();

C++

// 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", System.Convert.ToString(
    myWebRequest.get_Timeout()));
// Set the 'Timeout' property in Milliseconds.
myWebRequest.set_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();