Sys.Net.WebRequest の timeout プロパティ

更新 : 2007 年 11 月

Sys.Net.WebRequest インスタンスのタイムアウト値を取得または設定します。

メモ :
クライアント API プロパティのプロパティ値を取得または設定するには、名前のプレフィックスが get_ および set_ のプロパティ アクセサ メソッドを呼び出す必要があります。たとえば、cancel のプロパティの値を取得または設定するには、get_cancel メソッドまたは set_cancel メソッドを呼び出します。

var timeout = MyWebRequest.get_timeout();
MyWebRequest.set_timeout(value);

パラメータ

名前	定義
value	時間間隔 (ミリ秒単位)。

戻り値

現在の Web 要求タイムアウト値 (ミリ秒単位)。

例外

例外の種類	条件
Sys.ArgumentOutOfRangeException	value は負でない整数である必要があります。

解説

timeout プロパティは、WebRequest インスタンスに関連付けられているネットワーク エグゼキュータが、ネットワーク要求をタイムアウトするまで待機する時間間隔を表します。

タイムアウト間隔を設定することで、基になるネットワーク スタックが要求をタイムアウトするのを待たずに、保留中のネットワーク呼び出しがコントロールを確実に返すようにします。ネットワーク エグゼキュータは、値がゼロの場合、基になるネットワーク スタックがタイムアウトの原因だと解釈します。

使用例

要求のタイムアウト値を設定および取得する方法を次の例に示します。このコードは、WebRequest クラスの概要で説明しているコード例の一部分です。

// This function gets and sets the 
// Web request time out.
function WebRequestTimeout()
{     
    // Instantiate the WebRequest.
    var wRequest =  new Sys.Net.WebRequest();

    // Set the request Url.  
    wRequest.set_url(getPage);  

    var defaultTimeout =  
        wRequest.get_timeout();

    // Set request timeout to 100 msec.
    wRequest.set_timeout(100);

    var newTimeout = 
        wRequest.get_timeout();

    alert("Default timeout: " + defaultTimeout);
    alert("New timeout: " + newTimeout);

    // Set the web request completed event handler,
    // for processing return data.
    wRequest.add_completed(OnWebRequestCompleted);   

    // Execute the request.
    wRequest.invoke();       
}

参照

参照

Sys.Net.WebRequestManager クラス

Sys.Net.WebRequestExecutor クラス

Sys.Net.XMLHttpExecutor クラス