FtpWebRequest.Timeout プロパティ

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

FtpWebRequest.Timeout プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

要求に対するミリ秒単位の待機時間を取得または設定します。

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

Visual Basic (宣言)

Public Overrides Property
 Timeout As Integer

Visual Basic (使用法)

Dim instance As FtpWebRequest
Dim value As Integer

value = instance.Timeout

instance.Timeout = value

C#

public override int Timeout { get;
 set; }

C++

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

J#

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

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

JScript

public override function get
 Timeout () : int

public override function set
 Timeout (value : int)

プロパティ値
要求がタイムアウトになるまでのミリ秒単位の待機期間を格納している Int32 値。既定値は Infinite です。

例外

例外の種類	条件
ArgumentOutOfRangeException	指定した値が 0 未満のため Infinite ではありません。
InvalidOperationException	既に処理中の要求で、このプロパティに対して新しい値が指定されました。

解説

無期限の値を指定するには、Timeout プロパティを Infinite (-1) に設定します。これは既定値です。

Timeout は、GetResponse メソッドで行った同期要求が応答を待機し、GetRequestStream メソッドがストリームを待機する時間を表すミリ秒数です。リソースがタイムアウト時間内に応答しない場合、要求は WebException をスローし、Status プロパティを Timeout に設定します。

GetRequestStream、BeginGetRequestStream、GetResponse、または BeginGetResponse の各メソッドを呼び出した後に Timeout を変更すると、InvalidOperationException 例外が発生します。

ドメイン ネーム システム (DNS: Domain Name System) クエリが値を返すか、タイムアウトするまでに、最大で 15 秒かかることがあります。解決する必要があるホスト名が要求に含まれている場合、Timeout を 15 秒未満の値に設定していても、要求のタイムアウトを示す WebException がスローされるまでに 15 秒以上かかることがあります。

使用例

このプロパティを設定するコード例を次に示します。

C#

public static bool UploadUniqueFileOnServer
 (Uri serverUri, string fileName)
{
    // The URI described by serverUri should use the ftp:// scheme.
    // It contains the name of the directory on the server.
    // Example: ftp://contoso.com.
    // 
    // The fileName parameter identifies the file containing the data
 to be uploaded.

    if (serverUri.Scheme != Uri.UriSchemeFtp)
    {
        return false;
    }
    // Get the object used to communicate with the server.
    FtpWebRequest request = (FtpWebRequest)WebRequest.Create(serverUri);
    request.Method = WebRequestMethods.Ftp.UploadFileWithUniqueName;
    // Set a time limit for the operation to complete.
    request.Timeout = 600000;
    
    // Copy the file contents to the request stream.
    const int bufferLength = 2048;
    byte[] buffer = new byte[bufferLength];
    int count = 0;
    int readBytes = 0;
    FileStream stream = File.OpenRead(fileName);
    Stream requestStream = request.GetRequestStream();
    do
    {
        readBytes = stream.Read(buffer, 0, bufferLength);
        requestStream.Write(buffer, 0, bufferLength);
        count += readBytes;
    }
    while (readBytes != 0);
    
    Console.WriteLine ("Writing {0} bytes to the stream.", count);
    // IMPORTANT: Close the request stream before sending the request.
    requestStream.Close();
    FtpWebResponse response = (FtpWebResponse) request.GetResponse();
    Console.WriteLine("Upload status: {0}, {1}",response.StatusCode, response.StatusDescription);
         
    Console.WriteLine ("File name: {0}", response.ResponseUri);
    response.Close();
    return true;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
FtpWebRequest クラス
FtpWebRequest メンバ
System.Net 名前空間
FtpWebResponse
FtpStatusCode 列挙体
WebRequestMethods.Ftp
WebRequest
WebResponse
WebClient