IWebSocket interface for Unity including MessageWebSocket for Windows UWP

Author: David Douglas

README.md

@@ -6,11 +6,37 @@ For Unity developers looking to use Web Sockets in their Unity game / app.
 
 **First download the required dependencies and extract the contents into your Unity project "Assets" folder.**
 
-* [WebSocket-Sharp (fork with Custom Headers support)](https://github.com/deadlyfingers/websocket-sharp)
+* [WebSocket-Sharp* forked for supporting custom headers](https://github.com/deadlyfingers/websocket-sharp)
 
-## Developer notes
+## Features
 
-When using Unity 2017.2.1p2 and the .NET 4.6 API (Experimental) player settings I tried the system [ClientWebSocket](https://msdn.microsoft.com/en-us/library/system.net.websockets.clientwebsocket%28v=vs.110%29.aspx?f=255&MSPPError=-2147217396). While this initially had some success the problem was that after 3 mins or so the following error would occur on the async/await connect function:
+- **IWebSocket** interface for targeting the various platforms Unity supports. 
+  - **WebSocketMono** utilizes [WebSocket-Sharp*](https://github.com/deadlyfingers/websocket-sharp) and should work on all mono platforms including the Unity Editor on Mac and PC.
+  - **WebSocketUWP** utilizes [MessageWebSocket](https://docs.microsoft.com/en-us/uwp/api/windows.networking.sockets.messagewebsocket) for Windows 10 (UWP) apps.
+
+## Interface methods
+API | Description
+--- | -----------
+ConfigureWebSocket(url) | Configures web socket with url and optional headers
+ConnectAsync() | Connect to web socket
+CloseAsync() | Close web socket connection
+SendAsync(data) | Send binary `byte[]` or UTF-8 text `string` with optional callback
+IsOpen() | Check if web socket status is open
+Url() | Return the URL being used by the web socket
+
+## Interface event delegates
+	OnError(object sender, WebSocketErrorEventArgs e);
+	OnOpen(object sender, EventArgs e);
+	OnMessage(object sender, WebSocketMessageEventArgs e);
+	OnClose(object sender, WebSocketCloseEventArgs e);
+
+## Usage
+
+[UnityWebSocketDemo project repo](https://github.com/Unity3dAzure/UnityWebSocketDemo) contains sample scenes showing how to hook all this up in the Unity Editor.
+
+## Other developer notes
+
+When using Unity 2017.2.1p2 and the .NET 4.6 API (Experimental) player settings I tried the system [ClientWebSocket](https://msdn.microsoft.com/en-us/library/system.net.websockets.clientwebsocket%28v=vs.110%29.aspx?f=255&MSPPError=-2147217396). While this initially had some success the problem was that after 3 mins or so the following error would occur on the async/await connect function in the Unity Editor:
 
 ```
 ObjectDisposedException: Cannot access a disposed object.

UnityWebSocket.cs

@@ -1,18 +1,12 @@
-using System;
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.IO;
 using System.Text;
 using System.Text.RegularExpressions;
 using UnityEngine;
+using UnityEngine.Networking;
 using UnityEngine.UI;
-using WebSocketSharp;
-
-#if !NETFX_CORE || UNITY_ANDROID
-using System.Net;
-using System.Net.Security;
-using System.Security.Cryptography.X509Certificates;
-#endif
 
 namespace Unity3dAzure.WebSockets {
   public abstract class UnityWebSocket : MonoBehaviour {
@@ -21,14 +15,13 @@ public abstract class UnityWebSocket : MonoBehaviour {
     public static Data OnData;
 
     protected string WebSocketUri;
-    protected string Origin;
     protected List<UnityKeyValue> Headers;
-    protected uint WaitTime = 0; // seconds
 
-    private WebSocket _ws;
-    protected bool isActivated = false;
+    private IWebSocket _ws;
+
+    protected bool isAttached = false;
 
-    #region Web Socket methods
+#region Web Socket methods
 
     public virtual void Connect () {
       ConnectWebSocket ();
@@ -38,39 +31,40 @@ public virtual void Close () {
       DisconnectWebSocket ();
     }
 
-    #endregion
+#endregion
 
-    #region Web Socket handlers
+#region Web Socket handlers
 
     protected virtual void OnWebSocketOpen (object sender, EventArgs e) {
       Debug.Log ("Web socket is open");
     }
 
-    protected virtual void OnWebSocketClose (object sender, CloseEventArgs e) {
+    protected virtual void OnWebSocketClose (object sender, WebSocketCloseEventArgs e) {
       Debug.Log ("Web socket closed with reason: " + e.Reason);
       if (!e.WasClean) {
         DisconnectWebSocket ();
       }
+      DettachHandlers();
     }
 
-    protected virtual void OnWebSocketMessage (object sender, MessageEventArgs e) {
+    protected virtual void OnWebSocketMessage (object sender, WebSocketMessageEventArgs e) {
       Debug.LogFormat ("Web socket {1} message:\n{0}", e.Data, e.IsBinary ? "binary" : "string");
       // Raise web socket data handler event
       if (OnData != null) {
         OnData (e.RawData, e.Data, e.IsBinary);
       }
     }
-
-    protected virtual void OnWebSocketError (object sender, WebSocketSharp.ErrorEventArgs e) {
+    
+    protected virtual void OnWebSocketError (object sender, WebSocketErrorEventArgs e) {
       Debug.LogError ("Web socket error: " + e.Message);
       DisconnectWebSocket ();
     }
 
-    #endregion
+#endregion
 
     public void SendText (string text, Action<bool> callback = null) {
-      if (_ws == null || _ws.ReadyState != WebSocketSharp.WebSocketState.Open) {
-        Debug.LogWarning ("Web socket is not available to send message. Try connecting?");
+      if (_ws == null || !_ws.IsOpen()) {
+        Debug.LogWarning("Web socket is not available to send text message. Try connecting?");
         return;
       }
       _ws.SendAsync (text, callback);
@@ -86,100 +80,71 @@ public void SendInputText (InputField inputField) {
     }
 
     public void SendBytes (byte[] data, Action<bool> callback = null) {
-      if (_ws == null || _ws.ReadyState != WebSocketSharp.WebSocketState.Open) {
-        Debug.LogWarning ("Web socket is not available to send message. Try connecting?");
+      if (_ws == null || !_ws.IsOpen()) {
+        Debug.LogWarning("Web socket is not available to send bytes. Try connecting?");
         return;
       }
       _ws.SendAsync (data, callback);
     }
 
-    public void SendFile (FileInfo fileInfo, Action<bool> callback = null) {
-      if (_ws == null || _ws.ReadyState != WebSocketSharp.WebSocketState.Open) {
-        Debug.LogWarning ("Web socket is not available to send message. Try connecting?");
-        return;
-      }
-      _ws.SendAsync (fileInfo, callback);
-    }
-
     protected void ConnectWebSocket () {
       if (string.IsNullOrEmpty (WebSocketUri)) {
         Debug.LogError ("WebSocketUri must be set");
         return;
       }
 
       if (_ws == null) {
-        Debug.Log ("Create web socket uri: " + WebSocketUri);
-        _ws = new WebSocket (WebSocketUri);
-        // add origin
-        if (!string.IsNullOrEmpty (Origin)) {
-          _ws.Origin = Origin;
-        }
-        // set properties
-        if (WaitTime > 0) {
-          _ws.WaitTime = TimeSpan.FromSeconds (WaitTime);
-        }
-        // add headers
-        if (Headers != null || Headers.Count > 0) {
-          var customHeaders = new List<KeyValuePair<string, string>> ();
-          foreach (UnityKeyValue header in Headers) {
-            customHeaders.Add (new KeyValuePair<string, string> (header.key, header.value));
-          }
-          _ws.CustomHeaders = customHeaders;
+        var customHeaders = new List<KeyValuePair<string, string>>();
+        foreach (UnityKeyValue header in Headers) {
+          customHeaders.Add(new KeyValuePair<string, string>(header.key, header.value));
         }
+
+        Debug.Log ("Create Web Socket: " + WebSocketUri);
+#if ENABLE_WINMD_SUPPORT
+        Debug.Log ("Using UWP Web Socket");
+        _ws = new WebSocketUWP();
+#else
+        Debug.Log("Using Mono Web Socket");
+        _ws = new WebSocketMono();
+#endif
+        _ws.ConfigureWebSocket(WebSocketUri, customHeaders);
       }
 
-      if (!isActivated) {
-        Debug.Log ("Connect web socket");
-        isActivated = true;
-        _ws.OnError += OnWebSocketError;
-        _ws.OnOpen += OnWebSocketOpen;
-        _ws.OnMessage += OnWebSocketMessage;
-        _ws.OnClose += OnWebSocketClose;
+      if (!isAttached) {
+        Debug.Log ("Connect Web Socket: " + _ws.Url());
+        AttachHandlers();
         _ws.ConnectAsync ();
       }
     }
 
     protected void DisconnectWebSocket () {
-      if (_ws != null && isActivated) {
-        Debug.Log ("Disconnect web socket");
+      if (_ws != null && isAttached) {
+        Debug.Log ("Disconnect Web Socket");
         _ws.CloseAsync ();
-        _ws.OnError -= OnWebSocketError;
-        _ws.OnOpen -= OnWebSocketOpen;
-        _ws.OnMessage -= OnWebSocketMessage;
-        _ws.OnClose -= OnWebSocketClose;
-        isActivated = false;
       }
     }
 
-    #region Server Certificate Validation
-
-    protected void ValidateServerCertificate () {
-      // required for running in Windows and Android
-#if !NETFX_CORE || UNITY_ANDROID
-      ServicePointManager.ServerCertificateValidationCallback = RemoteCertificateValidationCallback;
-#endif
-    }
-
-    private static string HostName (string url) {
-      var match = Regex.Match (url, @"^(https:\/\/|http:\/\/|wss:\/\/|ws:\/\/)(www\.)?([a-z0-9-_]+\.[a-z]+)", RegexOptions.IgnoreCase);
-      if (match.Groups.Count == 4 && match.Groups[3].Value.Length > 0) {
-        return match.Groups[3].Value;
+    protected void AttachHandlers() {
+      if (isAttached) {
+        return;
       }
-      return url;
+      isAttached = true;
+      _ws.OnError += OnWebSocketError;
+      _ws.OnOpen += OnWebSocketOpen;
+      _ws.OnMessage += OnWebSocketMessage;
+      _ws.OnClose += OnWebSocketClose;
     }
 
-#if !NETFX_CORE || UNITY_ANDROID
-    private bool RemoteCertificateValidationCallback (System.Object sender, X509Certificate certificate, X509Chain chain, SslPolicyErrors sslPolicyErrors) {
-      // Check the certificate to see if it was issued from host
-      if (certificate.Subject.Contains (HostName (WebSocketUri))) {
-        return true;
-      } else {
-        return false;
+    protected void DettachHandlers() {
+      if (!isAttached) {
+        return;
       }
+      isAttached = false;
+      _ws.OnError -= OnWebSocketError;
+      _ws.OnOpen -= OnWebSocketOpen;
+      _ws.OnMessage -= OnWebSocketMessage;
+      _ws.OnClose -= OnWebSocketClose;
     }
-#endif
-
-    #endregion
 
   }
 

UnityWebSocketScript.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using UnityEngine;
 using WebSocketSharp;
@@ -12,9 +12,7 @@ public sealed class UnityWebSocketScript : UnityWebSocket {
     [SerializeField]
     private bool AutoConnect = false;
 
-    [Header ("Optional settings")]
-    [SerializeField]
-    private string origin;
+    [Header ("Optional config")]
     [SerializeField]
     private List<UnityKeyValue> headers;
 
@@ -23,12 +21,8 @@ public sealed class UnityWebSocketScript : UnityWebSocket {
     void Start () {
       // Config Websocket
       WebSocketUri = webSocketUri;
-      Origin = origin;
       Headers = headers;
 
-      // Validate Server Certificate
-      ValidateServerCertificate ();
-
       if (AutoConnect) {
         Connect ();
       }
@@ -64,22 +58,23 @@ protected override void OnWebSocketOpen (object sender, EventArgs e) {
       Debug.Log ("Web socket is open");
     }
 
-    protected override void OnWebSocketClose (object sender, CloseEventArgs e) {
+    protected override void OnWebSocketClose (object sender, WebSocketCloseEventArgs e) {
       Debug.Log ("Web socket closed with reason: " + e.Reason);
       if (!e.WasClean) {
         DisconnectWebSocket ();
       }
+      DettachHandlers();
     }
 
-    protected override void OnWebSocketMessage (object sender, MessageEventArgs e) {
+    protected override void OnWebSocketMessage (object sender, WebSocketMessageEventArgs e) {
       Debug.LogFormat ("Web socket {1} message:\n{0}", e.Data, e.IsBinary ? "binary" : "string");
       // Raise web socket data handler event
       if (OnData != null) {
         OnData (e.RawData, e.Data, e.IsBinary);
       }
     }
 
-    protected override void OnWebSocketError (object sender, WebSocketSharp.ErrorEventArgs e) {
+    protected override void OnWebSocketError (object sender, WebSocketErrorEventArgs e) {
       Debug.LogError ("Web socket error: " + e.Message);
       DisconnectWebSocket ();
     }

WebSocket/IWebSocket.cs

@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+
+namespace Unity3dAzure.WebSockets {
+  public interface IWebSocket {
+    void ConfigureWebSocket(string url);
+    void ConfigureWebSocket(string url, List<KeyValuePair<string, string>> headers);
+
+    void ConnectAsync();
+    void CloseAsync();
+
+    void SendAsync(byte[] data, Action<bool> completed = null);
+    void SendAsync(string text, Action<bool> completed = null);
+
+    bool IsOpen();
+    string Url();
+
+    event OnError OnError;
+    event OnOpen OnOpen;
+    event OnMessage OnMessage;
+    event OnClose OnClose;
+  }
+
+  public delegate void OnError(object sender, WebSocketErrorEventArgs e);
+  public delegate void OnOpen(object sender, EventArgs e);
+  public delegate void OnMessage(object sender, WebSocketMessageEventArgs e);
+  public delegate void OnClose(object sender, WebSocketCloseEventArgs e);
+}

WebSocket/WebSocketEvents/WebSocketCloseEventArgs.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace Unity3dAzure.WebSockets {
+  public class WebSocketCloseEventArgs : EventArgs {
+    public ushort Code;
+    public string Reason;
+    public bool WasClean;
+
+    public WebSocketCloseEventArgs(string reason="Unknown", ushort code=0) {
+      this.Code = code;
+      this.Reason = reason;
+      this.WasClean = (code == 1000) ? true : false;
+    }
+  }
+}

WebSocket/WebSocketEvents/WebSocketErrorEventArgs.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace Unity3dAzure.WebSockets {
+  public class WebSocketErrorEventArgs : EventArgs {
+    public string Message;
+
+    public WebSocketErrorEventArgs(string error) {
+      this.Message = error;
+    }
+  }
+}