BinaryReader.ReadBytes(Int32) の挙動について

Question

NetworkStreamからTCP受信データを読み取る際、受信途中であった場合、掲題のBinaryReader.ReadBytesメソッドは処理をブロックしますか？

var listener = TcpListener(selfHostName, receivePort);
listener.Start();
try
{
    using (var sender = listener.AcceptTcpClient())
    using (var receivedStream = sender.GetStream())
    using (var reader = new BinaryReader(receivedStream))
    {
        // ここで 10byte のデータが送られてくる想定。
        // もしここの処理に入った瞬間にまだ 10byte 未満（4byteとか）しか送られてきていない（送信途中）の場合、
        // 10byte 目が送られてくるまでブロックされますか？
        var readData = reader.ReadBytes(10);
    }
}
finally
{
    listener.Stop();
}

よろしくお願いいたします。

Answer 1

BinaryReader.ReadBytesメソッドは処理をブロックしますか？

はい。ご提示のコードにて、BinaryReaderで生成したリーダーオブジェクトを使う場合は、指定長分のデータを取り込むまでブロックします。つまりReadBytes(10)での呼び出しは10バイト取り出すまで、ReadInt16()の呼び出しは2バイト取り出すまでブロックします。

尚、BinaryReaderを使わずにsender.GetStream()で生成したNetworkStreamでReadを使うのであれば、ブロックしません。（それを踏まえてのご質問だったのかもしれませんが、参考まで）

using (var receivedStream = sender.GetStream())
{
    // ブロックせず、受信した分だけ取り出してすぐ戻る。
    Console.WriteLine("start.");
    byte[] bytes = new byte[256];
    int receivedLen = receivedStream.Read(bytes, 0, bytes.Length);
    Debug.WriteLine($"len={receivedLen}");
    string s = BitConverter.ToString(bytes, 0, receivedLen);
    Debug.WriteLine(s);
}

Answer 2

ブロックしません。
その時点に読み込まれたデータを返します

Comments

[castanopsia]

なるほど
ちなみに BinaryReader.ReadInt16() 等も同様でしょうか？

[y_waiwai]

ストリームの末尾に到達したら例外でますね

[castanopsia]

わかりました。回答ありがとうございました。

[Zuishin]

Stream の終わりに達したか、それともまだデータが送られてきてないかはどうやったらわかるんですか？

https://docs.microsoft.com/ja-jp/dotnet/api/system.io.binaryreader.readbytes?view=netframework-4.8
> 基になるストリームから読み取ったデータが格納されているバイト配列。 ストリームの末尾に到達した場合は要求したバイト数より小さくなることがあります。

[Zuishin]

あと、末尾に到達してさらに読み込もうとした場合(クローズされてない時)、どのような例外が出ますか？

[y_waiwai]

例外
EndOfStreamException
ストリームの末尾に到達しました。

とのことですねー

[Zuishin]

https://docs.microsoft.com/ja-jp/dotnet/api/system.io.binaryreader.readbyte?view=netframework-4.8

ReadByte の場合はその例外が書かれていますね。

https://docs.microsoft.com/ja-jp/dotnet/api/system.io.binaryreader.readbytes?view=netframework-4.8

でも ReadBytes にはありません。

本当に出ますか？

[Zuishin]

疑問形なのは、私が今それを確かめられる環境にいないからです。しかし、非常に疑わしいと思っています。

[y_waiwai]

ReadBytesでは空配列が帰るので、そんで判別できるって話なのでは。

[Zuishin]

では例外は出ないのでは？

[Zuishin]

そしてたまたままだデータが届いていないときにも空配列が戻るということは、ブロックされないのなら判別できないのでは？

[y_waiwai]

ReadBytes ではEndOfStreamExceptionはでないんでしょうね

[Zuishin]

ReadBytes の話をしています。質問にもそう書いてあります。本当にこの回答が正しいか、一度確かめてもらえませんか？

[y_waiwai]

castanopsia
2020/02/05 19:34
なるほど
ちなみに BinaryReader.ReadInt16() 等も同様でしょうか？

y_waiwai
2020/02/05 19:37
ストリームの末尾に到達したら例外でますね

という経緯ですね

[Zuishin]

同様ではないと思いましたので、確かめてください。

[dodox86]

私も？？と思ったので、確認しました。少なくとも質問者さんのコードではTCPのコネクションが生きている限り指定長を受信するまでReadBytes(10)は10バイト、ReadInt16は2バイト受信するまでブロックします。GetStream()やBinaryReader()が絡んでいるせいかもしれませんが。

[dodox86]

ストリームの末端の検出は、TCPコネクションが切れたとき、です。指定長の受信を待たず、System.IO.EndOfStreamException例外が発生します。

[Zuishin]

dodox86 さんありがとうございました。安心して眠れます。

[y_waiwai]

そういうことなら回答に書いてあげてください

[dodox86]

私のコメントで語弊がある表現がありましたので訂正させていただきます。
> 指定長を受信するまでReadBytes(10)は10バイト、ReadInt16は2バイト受信するまでブロックします。
受信するまで、と言うより「TCP上はデータは受信できているのだけれども、BinaryReaderを介する場合は、指定長分取り出せるようになるまでブロック」が正しいようです。で、回答させていただきました。