123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201 |
- #if !BESTHTTP_DISABLE_WEBSOCKET && (!UNITY_WEBGL || UNITY_EDITOR)
- using System;
- using System.Collections.Generic;
- using System.IO;
- using BestHTTP.Extensions;
- using BestHTTP.WebSocket.Extensions;
- namespace BestHTTP.WebSocket.Frames
- {
- /// <summary>
- /// Represents an incoming WebSocket Frame.
- /// </summary>
- public sealed class WebSocketFrameReader
- {
- #region Properties
- public byte Header { get; private set; }
- /// <summary>
- /// True if it's a final Frame in a sequence, or the only one.
- /// </summary>
- public bool IsFinal { get; private set; }
- /// <summary>
- /// The type of the Frame.
- /// </summary>
- public WebSocketFrameTypes Type { get; private set; }
- /// <summary>
- /// Indicates if there are any mask sent to decode the data.
- /// </summary>
- public bool HasMask { get; private set; }
- /// <summary>
- /// The length of the Data.
- /// </summary>
- public UInt64 Length { get; private set; }
- /// <summary>
- /// The sent byte array as a mask to decode the data.
- /// </summary>
- public byte[] Mask { get; private set; }
- /// <summary>
- /// The decoded array of bytes.
- /// </summary>
- public byte[] Data { get; private set; }
- /// <summary>
- /// Textual representation of the received Data.
- /// </summary>
- public string DataAsText { get; private set; }
- #endregion
- #region Internal & Private Functions
- internal void Read(Stream stream)
- {
- // For the complete documentation for this section see:
- // http://tools.ietf.org/html/rfc6455#section-5.2
- this.Header = ReadByte(stream);
- // The first byte is the Final Bit and the type of the frame
- IsFinal = (this.Header & 0x80) != 0;
- Type = (WebSocketFrameTypes)(this.Header & 0xF);
- byte maskAndLength = ReadByte(stream);
- // The second byte is the Mask Bit and the length of the payload data
- HasMask = (maskAndLength & 0x80) != 0;
- // if 0-125, that is the payload length.
- Length = (UInt64)(maskAndLength & 127);
- // If 126, the following 2 bytes interpreted as a 16-bit unsigned integer are the payload length.
- if (Length == 126)
- {
- byte[] rawLen = new byte[2];
- stream.ReadBuffer(rawLen);
- if (BitConverter.IsLittleEndian)
- Array.Reverse(rawLen, 0, rawLen.Length);
- Length = (UInt64)BitConverter.ToUInt16(rawLen, 0);
- }
- else if (Length == 127)
- {
- // If 127, the following 8 bytes interpreted as a 64-bit unsigned integer (the
- // most significant bit MUST be 0) are the payload length.
- byte[] rawLen = new byte[8];
- stream.ReadBuffer(rawLen);
- if (BitConverter.IsLittleEndian)
- Array.Reverse(rawLen, 0, rawLen.Length);
- Length = (UInt64)BitConverter.ToUInt64(rawLen, 0);
- }
- // Read the Mask, if has any
- if (HasMask)
- {
- Mask = new byte[4];
- if (stream.Read(Mask, 0, 4) < Mask.Length)
- throw ExceptionHelper.ServerClosedTCPStream();
- }
- Data = new byte[Length];
- if (Length == 0L)
- return;
- int readLength = 0;
- do
- {
- int read = stream.Read(Data, readLength, Data.Length - readLength);
- if (read <= 0)
- throw ExceptionHelper.ServerClosedTCPStream();
- readLength += read;
- } while (readLength < Data.Length);
- // It would be great to speed this up with SSE
- if (HasMask)
- for (int i = 0; i < Data.Length; ++i)
- Data[i] = (byte)(Data[i] ^ Mask[i % 4]);
- }
- private byte ReadByte(Stream stream)
- {
- int read = stream.ReadByte();
- if (read < 0)
- throw ExceptionHelper.ServerClosedTCPStream();
- return (byte)read;
- }
- #endregion
- #region Public Functions
- /// <summary>
- /// Assembles all fragments into a final frame. Call this on the last fragment of a frame.
- /// </summary>
- /// <param name="fragments">The list of previously downloaded and parsed fragments of the frame</param>
- public void Assemble(List<WebSocketFrameReader> fragments)
- {
- // this way the following algorithms will handle this fragment's data too
- fragments.Add(this);
- UInt64 finalLength = 0;
- for (int i = 0; i < fragments.Count; ++i)
- finalLength += fragments[i].Length;
- byte[] buffer = new byte[finalLength];
- UInt64 pos = 0;
- for (int i = 0; i < fragments.Count; ++i)
- {
- Array.Copy(fragments[i].Data, 0, buffer, (int)pos, (int)fragments[i].Length);
- pos += fragments[i].Length;
- }
- // All fragments of a message are of the same type, as set by the first fragment's opcode.
- this.Type = fragments[0].Type;
- // Reserver flags may be contained only in the first fragment
- this.Header = fragments[0].Header;
- this.Length = finalLength;
- this.Data = buffer;
- }
- /// <summary>
- /// This function will decode the received data incrementally with the associated websocket's extensions.
- /// </summary>
- public void DecodeWithExtensions(WebSocket webSocket)
- {
- if (webSocket.Extensions != null)
- for (int i = 0; i < webSocket.Extensions.Length; ++i)
- {
- var ext = webSocket.Extensions[i];
- if (ext != null)
- this.Data = ext.Decode(this.Header, this.Data);
- }
- if (this.Type == WebSocketFrameTypes.Text && this.Data != null)
- this.DataAsText = System.Text.Encoding.UTF8.GetString(this.Data, 0, this.Data.Length);
- }
- #endregion
- }
- }
- #endif
|