「Hello World」WebSocketサンプルの作成

Question

次のコードが機能しない理由がわかりません。 JavaScriptを使用してサーバーコンソールアプリケーションに接続したい。そして、サーバーにデータを送信します。

サーバーコードは次のとおりです。

    static void Main(string[] args)
    {            
        TcpListener server = new TcpListener(IPAddress.Parse("127.0.0.1"), 9998);
        server.Start();
        var client = server.AcceptTcpClient();
        var stream = client.GetStream();

        while (true)
        {
            var buffer = new byte[1024]; 
            // wait for data to be received
            var bytesRead = stream.Read(buffer, 0, buffer.Length);                
            var r = System.Text.Encoding.UTF8.GetString(buffer);
            // write received data to the console
            Console.WriteLine(r.Substring(0, bytesRead));
        }
    }

javaScriptは次のとおりです。

        var ws = new WebSocket("ws://localhost:9998/service");
        ws.onopen = function () {
            ws.send("Hello World"); // I WANT TO SEND THIS MESSAGE TO THE SERVER!!!!!!!!
        };

        ws.onmessage = function (evt) {
            var received_msg = evt.data;
            alert("Message is received...");
        };
        ws.onclose = function () {
            // websocket is closed.
            alert("Connection is closed...");
        };

そのコードを実行すると、これが起こります：

JavaScriptを実行すると、サーバーが接続を受け入れて正常に確立することに注意してください。ただし、JavaScriptはデータを送信できません。 sendメソッドを配置するたびに、接続が確立されても送信されません。この作業を行うにはどうすればよいですか？

Answer 1

WebSocketsは、TCPストリーミング接続に依存するプロトコルです。 WebSocketsはメッセージベースのプロトコルですが。

独自のプロトコルを実装する場合は、最新の安定した仕様（18/04/12向け） RFC 6455 を使用することをお勧めします。この仕様には、ハンドシェイクとフレーミングに関するすべての必要な情報が含まれています。同様に、ブラウザ側およびサーバー側からの動作のシナリオに関する説明のほとんど。コードの実装中は、サーバー側に関して推奨事項が示す内容に従うことを強くお勧めします。

簡単に言うと、次のようなWebSocketの操作について説明します。

1. サーバーSocket（System.Net.Sockets）を作成し、それを特定のポートにバインドし、接続の非同期受け入れで待機し続けます。そんな感じ：

   ソケットserverSocket = new Socket（AddressFamily.InterNetwork、SocketType.Stream、ProtocolType.IP）; 
    serverSocket.Bind（new IPEndPoint（IPAddress.Any、8080））; 
    serverSocket.Listen（128） ; 
    serverSocket.BeginAccept（null、0、OnAccept、null）;

2. ハンドシェイクを実装する（On-Accept）関数acceptingが必要です。将来、システムが毎秒の膨大な量の接続を処理することを意図している場合、別のスレッドにある必要があります。

   private void OnAccept（IAsyncResult result）{
    try {
    Socket client = null; 
    if（serverSocket！= null && serverSocket.IsBound）{
    client = serverSocket .EndAccept（result）; 
   } 
    if（client！= null）{
   /* ClientSocketのハンドシェイクと管理*/
   } 
   } catch（SocketException exception）{
    
   }最後に{
    if（serverSocket！= null && serverSocket.IsBound）{
    serverSocket.BeginAccept（null、0、OnAccept 、 ヌル）;
       }
   }
   }

3. 接続が確立されたら、handshakeを実行する必要があります。仕様に基づいて 1.3 Opening Handshake 、接続が確立された後、いくつかの情報を含む基本的なHTTP要求を受け取ります。例：

   GET/chat HTTP/1.1 
    Host：server.example.com 
    Upgrade：websocket 
    Connection：Upgrade 
    Sec-WebSocket-Key：dGhlIHNhbXBsZSBub25jZQ == 
    Origin：http://example.com 
    Sec-WebSocket-Protocol：chat、superchat 
    Sec-WebSocket-Version：13

   この例はプロトコル13のバージョンに基づいています。古いバージョンにはいくつかの違いがありますが、ほとんどの場合最新バージョンは相互互換性があることに注意してください。さまざまなブラウザが追加データを送信する場合があります。たとえば、ブラウザとOSの詳細、キャッシュなど。

   提供されたハンドシェイクの詳細に基づいて、回答行を生成する必要があります。それらはほとんど同じですが、提供されたSec-WebSocket-Keyに基づくAccpet-Keyが含まれます。仕様1.3では、応答キーの生成方法が明確に説明されています。 V13で使用してきた関数は次のとおりです。

   static private string guid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; 
    private string AcceptKey（ref string key）{
    string longKey = key + guid; 
    SHA1 sha1 = SHA1CryptoServiceProvider.Create（）; 
    byte [] hashBytes = sha1.ComputeHash（System.Text.Encoding.ASCII.GetBytes（longKey））; 
    return Convert.ToBase64String（hashBytes）; 
   } 
   

   ハンドシェイクの答えは次のようになります。

   HTTP/1.1 101スイッチングプロトコル
   アップグレード：websocket 
   接続：アップグレード
    Sec-WebSocket-Accept：s3pPLMBiTxaQ9kYGzzhZRbK + xOo =

   ただし、受け入れキーは、クライアントから提供されたキーと以前に提供されたAcceptKey Iメソッドに基づいて生成されたものでなければなりません。同様に、acceptキーの最後の文字の後に、2つの新しい行「\ r\n\r\n」を入力してください。

4. ハンドシェイク応答がサーバーから送信された後、クライアントは「onopen」関数をトリガーする必要があります。つまり、後でメッセージを送信できます。
5. メッセージは未加工形式で送信されませんが、Data Framingがあります。また、クライアントからサーバーまで、メッセージヘッダーで提供された4バイトに基づいてデータのマスキングを実装します。サーバーからクライアントまで、データにマスキングを適用する必要はありません。仕様のセクション 5。Data Framing を読んでください。これは私自身の実装からのコピーアンドペーストです。これはすぐに使用できるコードではなく、修正する必要があります。WebSocketフレーミングによる読み取り/書き込みのアイデアと全体的なロジックを示すために投稿しています。 このリンク に移動します。
6. フレーミングの実装後、ソケットを使用して正しい方法でデータを受信するようにしてください。たとえば、TCPはストリームベースのプロトコルであるため、一部のメッセージが1つにマージされるのを防ぐためです。つまり、特定のバイトのみを読み取る必要があります。メッセージの長さは常にヘッダーに基づいており、ヘッダー自体のデータ長の詳細を提供します。したがって、ソケットからデータを受信する場合、最初に2バイトを受信し、フレーミング仕様に基づいてヘッダーから詳細を取得し、次にマスクがさらに4バイトを提供した場合、データの長さに基づいて1、4または8バイトの長さを取得します。そして、データそれ自体の後。読み取った後、デマスキングを適用すると、メッセージデータを使用する準備が整います。
7. いくつかのData Protocolを使用したい場合があります。JavaScriptのクライアント側で使いやすいトラフィックエコノミーのJSONを使用することをお勧めします。サーバー側では、いくつかのパーサーをチェックする必要があります。それらの多くがあります、グーグルは本当に役に立ちます。

独自のWebSocketsプロトコルを実装することには、プロトコル自体を制御するだけでなく、いくつかの利点と素晴らしい経験があります。しかし、それを行うにはある程度の時間を費やし、実装の信頼性が高いことを確認する必要があります。

同時に、あなたはグーグル（再び）が十分に持っているソリューションを使用する準備ができているのを見るかもしれません。

Answer 2

（OPに代わって回答を投稿）。

データを送信できるようになりました。これはあなたの答えと@Maksims Mihejevsのコードのおかげでプログラムの私の新しいバージョンです。

サーバ

using System;
using System.Net.Sockets;
using System.Net;
using System.Security.Cryptography;
using System.Threading;

namespace ConsoleApplication1
{
    class Program
    {
        static Socket serverSocket = new Socket(AddressFamily.InterNetwork, 
        SocketType.Stream, ProtocolType.IP);
        static private string guid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

        static void Main(string[] args)
        {            
            serverSocket.Bind(new IPEndPoint(IPAddress.Any, 8080));
            serverSocket.Listen(128);
            serverSocket.BeginAccept(null, 0, OnAccept, null);            
            Console.Read();
        }

        private static void OnAccept(IAsyncResult result)
        {
            byte[] buffer = new byte[1024];
            try
            {
                Socket client = null;
                string headerResponse = "";
                if (serverSocket != null && serverSocket.IsBound)
                {
                    client = serverSocket.EndAccept(result);
                    var i = client.Receive(buffer);
                    headerResponse = (System.Text.Encoding.UTF8.GetString(buffer)).Substring(0,i);
                    // write received data to the console
                    Console.WriteLine(headerResponse);

                }
                if (client != null)
                {
                    /* Handshaking and managing ClientSocket */

                    var key = headerResponse.Replace("ey:", "`")
                              .Split('`')[1]                     // dGhlIHNhbXBsZSBub25jZQ== \r\n .......
                              .Replace("\r", "").Split('\n')[0]  // dGhlIHNhbXBsZSBub25jZQ==
                              .Trim();

                    // key should now equal dGhlIHNhbXBsZSBub25jZQ==
                    var test1 = AcceptKey(ref key);

                    var newLine = "\r\n";

                    var response = "HTTP/1.1 101 Switching Protocols" + newLine
                         + "Upgrade: websocket" + newLine
                         + "Connection: Upgrade" + newLine
                         + "Sec-WebSocket-Accept: " + test1 + newLine + newLine
                         //+ "Sec-WebSocket-Protocol: chat, superchat" + newLine
                         //+ "Sec-WebSocket-Version: 13" + newLine
                         ;

                    // which one should I use? none of them fires the onopen method
                    client.Send(System.Text.Encoding.UTF8.GetBytes(response));

                    var i = client.Receive(buffer); // wait for client to send a message

                    // once the message is received decode it in different formats
                    Console.WriteLine(Convert.ToBase64String(buffer).Substring(0, i));                    

                    Console.WriteLine("\n\nPress enter to send data to client");
                    Console.Read();

                    var subA = SubArray<byte>(buffer, 0, i);
                    client.Send(subA);
                    Thread.Sleep(10000);//wait for message to be send


                }
            }
            catch (SocketException exception)
            {
                throw exception;
            }
            finally
            {
                if (serverSocket != null && serverSocket.IsBound)
                {
                    serverSocket.BeginAccept(null, 0, OnAccept, null);
                }
            }
        }

        public static T[] SubArray<T>(T[] data, int index, int length)
        {
            T[] result = new T[length];
            Array.Copy(data, index, result, 0, length);
            return result;
        }

        private static string AcceptKey(ref string key)
        {
            string longKey = key + guid;
            byte[] hashBytes = ComputeHash(longKey);
            return Convert.ToBase64String(hashBytes);
        }

        static SHA1 sha1 = SHA1CryptoServiceProvider.Create();
        private static byte[] ComputeHash(string str)
        {
            return sha1.ComputeHash(System.Text.Encoding.ASCII.GetBytes(str));
        }
    }
}

JavaScript：

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <script type="text/javascript">
        function connect() {
            var ws = new WebSocket("ws://localhost:8080/service");
            ws.onopen = function () {
                alert("About to send data");
                ws.send("Hello World"); // I WANT TO SEND THIS MESSAGE TO THE SERVER!!!!!!!!
                alert("Message sent!");
            };

            ws.onmessage = function (evt) {
                alert("About to receive data");
                var received_msg = evt.data;
                alert("Message received = "+received_msg);
            };
            ws.onclose = function () {
                // websocket is closed.
                alert("Connection is closed...");
            };
        };


    </script>
</head>
<body style="font-size:xx-large" >
    <div>
    <a href="#" onclick="connect()">Click here to start</a></div>
</body>
</html>

そのコードを実行すると、クライアントとサーバーの両方からデータを送受信できます。唯一の問題は、メッセージがサーバーに到着したときに暗号化されることです。プログラムの実行手順は次のとおりです。

クライアントからのメッセージがどのように暗号化されるかに注意してください。

Answer 3

WebSocketは プロトコルで実装 であり、これには クライアントとサーバー間のハンドシェイク が含まれます。通常のソケットと同じように機能するとは思わない。プロトコルを読んで、アプリケーションにそれを話させてください。または、既存のWebSocketライブラリ、または WebSocket API を持つ.Net4.5betaを使用します。

Answer 4

問題

WebSocketを使用しているので、費用は正しいです。 WebSocketから初期データを受信した後、C＃サーバーからハンドシェイクメッセージを送信してから、さらに情報を流す必要があります。

HTTP/1.1 101 Web Socket Protocol Handshake
Upgrade: websocket
Connection: Upgrade
WebSocket-Origin: example
WebSocket-Location: something.here
WebSocket-Protocol: 13

それらの線に沿って何か。

WebSocketがw3またはgoogleでどのように機能するかについて、さらに調査することができます。

リンクとリソース

プロトコルの仕様は次のとおりです。 http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76#section-1.

実際の例のリスト：

• https://stackoverflow.com/a/5866975/184746
• https://stackoverflow.com/a/2212752/184746
• http://ashishware.com/websocksample.shtml
• http://www.sencha.com/forum/showthread.php?99842-WebSocket-server-in-C

Answer 5

どこでも（1月19日の時点で）簡単な作業例を見つけることができなかったため、ここに更新されたバージョンがあります。 chromeバージョン71.0.3578.98があります。

C＃Websocketサーバー：

using System;
using System.Text;
using System.Net;
using System.Net.Sockets;
using System.Security.Cryptography;

namespace WebSocketServer
{
    class Program
    {
    static Socket serverSocket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.IP);
    static private string guid = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

    static void Main(string[] args)
    {
        serverSocket.Bind(new IPEndPoint(IPAddress.Any, 8080));
        serverSocket.Listen(1); //just one socket
        serverSocket.BeginAccept(null, 0, OnAccept, null);
        Console.Read();
    }

    private static void OnAccept(IAsyncResult result)
    {
        byte[] buffer = new byte[1024];
        try
        {
            Socket client = null;
            string headerResponse = "";
            if (serverSocket != null && serverSocket.IsBound)
            {
                client = serverSocket.EndAccept(result);
                var i = client.Receive(buffer);
                headerResponse = (System.Text.Encoding.UTF8.GetString(buffer)).Substring(0, i);
                // write received data to the console
                Console.WriteLine(headerResponse);
                Console.WriteLine("=====================");
            }
            if (client != null)
            {
                /* Handshaking and managing ClientSocket */
                var key = headerResponse.Replace("ey:", "`")
                          .Split('`')[1]                     // dGhlIHNhbXBsZSBub25jZQ== \r\n .......
                          .Replace("\r", "").Split('\n')[0]  // dGhlIHNhbXBsZSBub25jZQ==
                          .Trim();

                // key should now equal dGhlIHNhbXBsZSBub25jZQ==
                var test1 = AcceptKey(ref key);

                var newLine = "\r\n";

                var response = "HTTP/1.1 101 Switching Protocols" + newLine
                     + "Upgrade: websocket" + newLine
                     + "Connection: Upgrade" + newLine
                     + "Sec-WebSocket-Accept: " + test1 + newLine + newLine
                     //+ "Sec-WebSocket-Protocol: chat, superchat" + newLine
                     //+ "Sec-WebSocket-Version: 13" + newLine
                     ;

                client.Send(System.Text.Encoding.UTF8.GetBytes(response));
                var i = client.Receive(buffer); // wait for client to send a message
                string browserSent = GetDecodedData(buffer, i);
                Console.WriteLine("BrowserSent: " + browserSent);

                Console.WriteLine("=====================");
                //now send message to client
                client.Send(GetFrameFromString("This is message from server to client."));
                System.Threading.Thread.Sleep(10000);//wait for message to be sent
            }
        }
        catch (SocketException exception)
        {
            throw exception;
        }
        finally
        {
            if (serverSocket != null && serverSocket.IsBound)
            {
                serverSocket.BeginAccept(null, 0, OnAccept, null);
            }
        }
    }

    public static T[] SubArray<T>(T[] data, int index, int length)
    {
        T[] result = new T[length];
        Array.Copy(data, index, result, 0, length);
        return result;
    }

    private static string AcceptKey(ref string key)
    {
        string longKey = key + guid;
        byte[] hashBytes = ComputeHash(longKey);
        return Convert.ToBase64String(hashBytes);
    }

    static SHA1 sha1 = SHA1CryptoServiceProvider.Create();
    private static byte[] ComputeHash(string str)
    {
        return sha1.ComputeHash(System.Text.Encoding.ASCII.GetBytes(str));
    }

    //Needed to decode frame
    public static string GetDecodedData(byte[] buffer, int length)
    {
        byte b = buffer[1];
        int dataLength = 0;
        int totalLength = 0;
        int keyIndex = 0;

        if (b - 128 <= 125)
        {
            dataLength = b - 128;
            keyIndex = 2;
            totalLength = dataLength + 6;
        }

        if (b - 128 == 126)
        {
            dataLength = BitConverter.ToInt16(new byte[] { buffer[3], buffer[2] }, 0);
            keyIndex = 4;
            totalLength = dataLength + 8;
        }

        if (b - 128 == 127)
        {
            dataLength = (int)BitConverter.ToInt64(new byte[] { buffer[9], buffer[8], buffer[7], buffer[6], buffer[5], buffer[4], buffer[3], buffer[2] }, 0);
            keyIndex = 10;
            totalLength = dataLength + 14;
        }

        if (totalLength > length)
            throw new Exception("The buffer length is small than the data length");

        byte[] key = new byte[] { buffer[keyIndex], buffer[keyIndex + 1], buffer[keyIndex + 2], buffer[keyIndex + 3] };

        int dataIndex = keyIndex + 4;
        int count = 0;
        for (int i = dataIndex; i < totalLength; i++)
        {
            buffer[i] = (byte)(buffer[i] ^ key[count % 4]);
            count++;
        }

        return Encoding.ASCII.GetString(buffer, dataIndex, dataLength);
    }

    //function to create  frames to send to client 
    /// <summary>
    /// Enum for opcode types
    /// </summary>
    public enum EOpcodeType
    {
        /* Denotes a continuation code */
        Fragment = 0,

        /* Denotes a text code */
        Text = 1,

        /* Denotes a binary code */
        Binary = 2,

        /* Denotes a closed connection */
        ClosedConnection = 8,

        /* Denotes a ping*/
        Ping = 9,

        /* Denotes a pong */
        Pong = 10
    }

    /// <summary>Gets an encoded websocket frame to send to a client from a string</summary>
    /// <param name="Message">The message to encode into the frame</param>
    /// <param name="Opcode">The opcode of the frame</param>
    /// <returns>Byte array in form of a websocket frame</returns>
    public static byte[] GetFrameFromString(string Message, EOpcodeType Opcode = EOpcodeType.Text)
    {
        byte[] response;
        byte[] bytesRaw = Encoding.Default.GetBytes(Message);
        byte[] frame = new byte[10];

        int indexStartRawData = -1;
        int length = bytesRaw.Length;

        frame[0] = (byte)(128 + (int)Opcode);
        if (length <= 125)
        {
            frame[1] = (byte)length;
            indexStartRawData = 2;
        }
        else if (length >= 126 && length <= 65535)
        {
            frame[1] = (byte)126;
            frame[2] = (byte)((length >> 8) & 255);
            frame[3] = (byte)(length & 255);
            indexStartRawData = 4;
        }
        else
        {
            frame[1] = (byte)127;
            frame[2] = (byte)((length >> 56) & 255);
            frame[3] = (byte)((length >> 48) & 255);
            frame[4] = (byte)((length >> 40) & 255);
            frame[5] = (byte)((length >> 32) & 255);
            frame[6] = (byte)((length >> 24) & 255);
            frame[7] = (byte)((length >> 16) & 255);
            frame[8] = (byte)((length >> 8) & 255);
            frame[9] = (byte)(length & 255);

            indexStartRawData = 10;
        }

        response = new byte[indexStartRawData + length];

        int i, reponseIdx = 0;

        //Add the frame bytes to the reponse
        for (i = 0; i < indexStartRawData; i++)
        {
            response[reponseIdx] = frame[i];
            reponseIdx++;
        }

        //Add the data bytes to the response
        for (i = 0; i < length; i++)
        {
            response[reponseIdx] = bytesRaw[i];
            reponseIdx++;
        }

        return response;
    }
}
}

クライアントhtmlおよびjavascript：

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <script type="text/javascript">
        var socket = new WebSocket('ws://localhost:8080/websession');
        socket.onopen = function() {
           // alert('handshake successfully established. May send data now...');
                   socket.send("Hi there from browser.");
        };
                socket.onmessage = function (evt) {
                //alert("About to receive data");
                var received_msg = evt.data;
                alert("Message received = "+received_msg);
            };
        socket.onclose = function() {
            alert('connection closed');
        };
    </script>
</head>
<body>
</body>
</html>

Answer 6

これらの簡単な例を試してみてください...

• C＃WebSocketサーバー

• C＃WebSocketクライアント