質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.51%

  • C#

    8511questions

    C#はマルチパラダイムプログラミング言語の1つで、命令形・宣言型・関数型・ジェネリック型・コンポーネント指向・オブジェクティブ指向のプログラミング開発すべてに対応しています。

  • ASP.NET

    599questions

    ASP.NETは動的なWebサイトやWebアプリケーション、そしてWebサービスを構築出来るようにする為、Microsoftによって開発されたウェブアプリケーション開発フレームワークです。

  • WebSocket

    186questions

    WebSocketとは双方向・全二重コミュニケーションのためのAPIでありプロトコルのことを指します。WebSocketはHTML5に密接に結びついており、多くのウェブブラウザの最新版に導入されています。

ClientWebSocket.CloseAsync メソッドが完了しない

解決済

回答 2

投稿 編集

  • 評価
  • クリップ 1
  • VIEW 1,106

NumAniCloud

score 40

 環境

サーバーはlocalhostにて実行しており、サーバー側とクライアント側は同一のマシンです。

マシン

  • OS:Windows 10
  • デバッグ環境:Visual Studio Community 2017

サーバー側

  • フレームワーク:ASP.NET Core, .NET Core 2.0

クライアント側

  • フレームワーク:.NET Framework 4.6.1

 問題

WebSocketを用いたサーバー・クライアント間のデータのやりとりを実装しています。
クライアント側はClientWebSocketを用いて実装していますが、ClientWebSocket.CloseAsyncを呼び出すとプログラムが進行しなくなってしまいます。以下にソースコードの関係の有りそうな箇所を掲載しますので、どこが間違っているか、もしくはCloseAsyncでプログラムが進行しなくなる時にありがちな事などご指摘いただけると助かります。

テスト用のプロジェクトでは再現しないため再現コードが書けずに申し訳ありませんが、再現するほうのプロジェクトでは以下のようなメソッド呼び出しでコネクションを閉じようとしています。大規模なコードであるため全ては載せられませんでした。

// クライアント側
if (WebSocket.State == WebSocketState.Open)
{
    // このメソッド呼び出しが完了せず、プログラムが進行を停止する
    WebSocket.CloseAsync(System.Net.WebSockets.WebSocketCloseStatus.NormalClosure,
        "正常終了",
        CancellationToken.None).Wait();
}

サーバー側は以下のように応答します。

// サーバー側
// コネクションが確立したときに呼び出され、データの受信を待機するメソッド
public async Task ListenConnectionAsync(OpenRoom room)
{
    var buffer = new byte[1024 * 4];

    // 接続していればリクエストを待つ
    while (room.Receiver.State == System.Net.WebSockets.WebSocketState.Open)
    {
        var result = await room.Receiver.ReceiveAsync(
            buffer: new ArraySegment<byte>(buffer),
            cancellationToken: CancellationToken.None);

        // 通常のデータ受信
        if (result.MessageType == System.Net.WebSockets.WebSocketMessageType.Text)
        {
            // CastEventData はサーバー・クライアント間でやりとりするデータ
            try
            {
                var message = CastEventData.Deserialize(buffer, result.Count);
                await room.ReceiveAsync(message);
            }
            catch(Exception e)
            {
                Console.WriteLine(e);
            }
        }
        // コネクションを閉じるリクエストを受信した場合
        else if(result.MessageType == System.Net.WebSockets.WebSocketMessageType.Close)
        {
            // コネクションを閉じるリクエストに応答する
            await room.Receiver.CloseOutputAsync(System.Net.WebSockets.WebSocketCloseStatus.NormalClosure,
                "正常終了",
                CancellationToken.None);
            break;
        }
    }
}

// CastEventData, CastDataはサーバー・クライアント間でやりとりするデータ
public class OpenRoom
{
    public string Name { get; set; }
    public CastData CastData { get; set; }
    public System.Net.WebSockets.WebSocket Receiver { get; set; }
    public List<System.Net.WebSockets.WebSocket> Senders { get; set; }

    internal Task ReceiveAsync(CastEventData message)
    {
        message.Event.Apply(CastData);  // イベントに応じてサーバー上のデータを書き換える
        return Task.CompletedTask;
    }
}

 デバッグ内容

この問題について、ブレークポイントを置いてデバッグしています。クライアント側からコネクションを閉じるリクエストを送ると、サーバー側では「コネクションを閉じるリクエストに応答する」のコメントの部分が実行されました。これによってサーバーからクライアントへの応答もできているつもりなのですが、うまく行かず悩んでいるところです。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • Zuishin

    2018/03/04 18:53

    再現コードが書けないとあるので違うなら書き直してください。

    キャンセル

  • umyu

    2018/03/05 01:49 編集

    WebSocketはあまり触ったことが無いので、こちらで。サーバー側のコネクションを閉じるリクエストを受信した場合の判定ですが、CloseもしくはCloseReceivedではないでしょうか?
    ■参考情報 WebSocket closing handshake
    https://wiki.suikawiki.org/n/WebSocket%20closing%20handshake

    キャンセル

  • NumAniCloud

    2018/03/05 22:25 編集

    皆さんご返信ありがとうございます。クライアントからのリクエストをサーバーが受け取る前に、サーバー側のwhileループを抜けてしまってリクエストが受け取れていないのではないか、ということでしょうか?今回の問題では、実行するとサーバー側にある「コネクションを閉じるリクエストに応答する」のコメントの部分を通ったので、おそらくwhileループの条件の問題では無いのではないかと思っています(質問に書けていなくて申し訳ありません。追記します)。試しにwhileループの条件式に`Closed`や`CloseReceived`を含めてみましたが、効果はありませんでした。

    キャンセル

回答 2

check解決した方法

+1

解決しました。

定期的な更新処理の呼び出しが必要な独自の同期コンテキストを使用した状況下で、更新処理なくTaskWaitしたためにデッドロックが発生していたようでした。

今回のプロジェクトはゲームプログラムであり、以下の記事に出てくるようなゲームループを利用した同期コンテキストを用いていました。

コルーチン用途にawaitを使うためのSynchronizationContext

この同期コンテキストは定期的に更新処理を呼び出す必要があり、問題のコードでWaitメソッドを使用した場所では定期的な更新処理が呼び出されていませんでした。独自の同期コンテキストを正しく更新して使うように変更すると、CloseAsyncメソッドが正しく完了するようになりました。

今回の問題は、Waitメソッドで待機したタスクは同期コンテキストへ投げられないだろうという勘違いが原因でした。

情報の不足した質問により大変失礼いたしました。皆様ご回答ありがとうございました。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

メソッドがUIスレッド上で実行されていて、クライアント側のWait処理でTaskの完了を待っているためではないでしょうか?

https://msdn.microsoft.com/ja-jp/library/system.threading.tasks.task.wait(v=vs.110).aspx

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2018/03/07 21:39

    クライアント側にてWaitメソッドの呼び出しをUIスレッドで行っているために、スレッドがブロックされてしまいプログラムが応答なしになってしまう問題があるということでしょうか?今回はスレッドが一定時間ブロックされることは許容できるのですが、問題はCloseAsyncメソッドがいつまで経っても完了せず、プログラムが進行しなくなってしまうことなのです。質問の情報が不足しており申し訳ありませんが、ご回答頂きありがとうございます。

    キャンセル

同じタグがついた質問を見る

  • C#

    8511questions

    C#はマルチパラダイムプログラミング言語の1つで、命令形・宣言型・関数型・ジェネリック型・コンポーネント指向・オブジェクティブ指向のプログラミング開発すべてに対応しています。

  • ASP.NET

    599questions

    ASP.NETは動的なWebサイトやWebアプリケーション、そしてWebサービスを構築出来るようにする為、Microsoftによって開発されたウェブアプリケーション開発フレームワークです。

  • WebSocket

    186questions

    WebSocketとは双方向・全二重コミュニケーションのためのAPIでありプロトコルのことを指します。WebSocketはHTML5に密接に結びついており、多くのウェブブラウザの最新版に導入されています。