TcpClient.Available プロパティ

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

TcpClient.Available プロパティ

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

ネットワークから受信した、読み取り可能なデータ量を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 Available As Integer

Visual Basic (使用法)

Dim instance As TcpClient
Dim value As Integer

value = instance.Available

C#

public int Available { get;
 }

C++

public:
property int Available {
    int get ();
}

J#

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

JScript

public function get Available
 () : int

プロパティ値
ネットワークから受信した、読み取り可能なデータのバイト数。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。

解説

Available を使用すると、データが読み取り用のキューに置かれているかどうかを確認できます。データがある場合は、Read を呼び出してデータを取得します。読み取り用のネットワーク バッファのキューに置かれているデータ総量をデータとして使用できます。ネットワーク バッファのキューにデータが置かれていない場合、Available は 0 を返します。

リモート ホストがシャットダウンするか接続を閉じると、Available は SocketException をスローする場合があります。SocketException が発生した場合は、SocketException.ErrorCode を使用して具体的なエラー コードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラー コードのマニュアルからエラーの詳細情報を確認してください。これは MSDN ライブラリ (http://msdn.microsoft.com/library/ja/) から入手できます。

使用例

Available プロパティを使用するコード例を次に示します。

C#

static void GetAvailable()
{
    // Find out how many bytes are ready to be read.
    Console.WriteLine("Availabe value is {0}", t.Available);
}

C++

static void GetAvailable( TcpClient^ t )
{
   // Find out how many bytes are ready to be read.
   Console::WriteLine( "Available value is {0}", t->Available.ToString()
 );
   ;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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

参照

関連項目
TcpClient クラス
TcpClient メンバ
System.Net.Sockets 名前空間