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

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

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

Socket.Available プロパティ

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

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

Visual Basic (宣言)

Public ReadOnly Property
 Available As Integer

Visual Basic (使用法)

Dim instance As Socket
Dim value As Integer

value = instance.Available

public int Available { get;
 }

C++

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

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

JScript

public function get Available
 () : int

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

例外

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

解説

非ブロッキング Socket を使用している場合は、Receive を呼び出す前に、Available を使用してデータが読み取り用のキューに置かれているかどうかを確認することをお勧めします。読み取り用のネットワークバッファのキューに置かれているデータ総量をデータとして使用できます。ネットワークバッファのキューにデータが置かれていない場合、Available は 0 を返します。

リモートホストがシャットダウンするか接続を閉じると、Available は SocketException をスローできます。SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラーコードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラーコードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメンバは、アプリケーションでネットワークトレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

次に示すのは、FIONREAD を使用して IOControl を呼び出した場合と、Available プロパティを使用した場合とを比較するコード例です。

 // FIONREAD is also available as the "Available" property.
public const int FIONREAD
   = 0x4004667F;

static void DisplayPendingByteCount(Socket
 s)
 {
     byte[] outValue = BitConverter.GetBytes(0);

     // Check how many bytes have been received.
     s.IOControl(FIONREAD, null, outValue);
     
     uint bytesAvailable = BitConverter.ToUInt32(outValue, 0);
     Console.WriteLine("server has {0} bytes pending. Available property says
 {1}.",
         bytesAvailable, s.Available);
     
     return;
 }

C++

// FIONREAD is also available as the "Available" property.
const int FIONREAD = 0x4004667F;

void DisplayPendingByteCount( Socket^ s )
{
   array<Byte>^ outValue = BitConverter::GetBytes( 0 );
   
   // Check how many bytes have been received.
   s->IOControl( FIONREAD, nullptr, outValue );

   UInt32 bytesAvailable = BitConverter::ToUInt32( outValue, 0 );
   Console::WriteLine( "server has {0} bytes pending. Available property says
 {1}.",
      bytesAvailable, s->Available );

   return;
}

// FIONREAD is also available as the "Available" property.
public static final int
 FIONREAD = 0x4004667F;

static void DisplayPendingByteCount(Socket
 s)
{
    ubyte outValue[] = BitConverter.GetBytes(0);
    // Check how many bytes have been received.
    s.IOControl(FIONREAD, null, outValue);

    UInt32 bytesAvailable = BitConverter.ToUInt32(outValue, 0);
    //ToDo: Unsigned Integers not supported- converted to int
    Console.WriteLine("server has {0} bytes pending. Available property "
        + "says {1}.", bytesAvailable.ToString(), 
        (System.Int32)s.get_Available());
    return;
} //DisplayPendingByteCount