Socket.Available Socket.Available Socket.Available Socket.Available Property

定義

ネットワークから受信した、読み取り可能なデータ量を取得します。Gets the amount of data that has been received from the network and is available to be read.

public:
 property int Available { int get(); };
public int Available { get; }
member this.Available : int
Public ReadOnly Property Available As Integer

プロパティ値

ネットワークから受信した、読み取り可能なデータのバイト数。The number of bytes of data received from the network and available to be read.

例外

ソケットへのアクセスを試行しているときにエラーが発生しました。An error occurred when attempting to access the socket.

次のコード例では、Ioonread と使用可能なプロパティを呼び出して、呼び出しの結果を比較しています。The following code example compares the results of calling IOControl with FIONREAD and the Available property.

// 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 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;
 }

注釈

非ブロッキングSocketを使用している場合はAvailable 、を呼び出すReceive前に、データが読み取り用にキューに格納されているかどうかを判断することをお勧めします。If you are using a non-blocking Socket, Available is a good way to determine whether data is queued for reading, before calling Receive. 使用可能なデータは、読み取り用にネットワークバッファーにキューに格納されているデータの総量です。The available data is the total amount of data queued in the network buffer for reading. データがネットワークバッファーに格納されていAvailableない場合、は0を返します。If no data is queued in the network buffer, Available returns 0.

リモートホストがシャットダウンまたは接続を閉じると、 AvailableはをSocketExceptionスローすることがあります。If the remote host shuts down or closes the connection, Available can throw a SocketException. SocketException受け取った場合は、 SocketException.ErrorCodeプロパティを使用して、特定のエラーコードを取得します。If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. このコードを取得したら、 Windows Sockets version 2 API エラーコードのドキュメントを参照して、エラーの詳細な説明を参照してください。After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。This member outputs trace information when you enable network tracing in your application. 詳細については、「 .NET Framework のネットワークトレース」を参照してください。For more information, see Network Tracing in the .NET Framework.

適用対象

こちらもご覧ください