UnityWebSocket using websocket-sharp

Author: David Douglas

.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+[*.json]
+insert_final_newline = ignore
+

.gitignore

@@ -0,0 +1,40 @@
+/[Ll]ibrary/
+/[Tt]emp/
+/[Oo]bj/
+/[Bb]uild/
+/[Bb]uilds/
+/Assets/AssetStoreTools*
+
+# Visual Studio 2015 cache directory
+/.vs/
+
+# Autogenerated VS/MD/Consulo solution and project files
+ExportedObj/
+.consulo/
+*.csproj
+*.unityproj
+*.sln
+*.suo
+*.tmp
+*.user
+*.userprefs
+*.pidb
+*.booproj
+*.svd
+*.pdb
+
+# Unity3D generated meta files
+*.pidb.meta
+*.meta
+
+# Unity3D Generated File On Crash Reports
+sysinfo.txt
+
+# Builds
+*.apk
+*.unitypackage
+
+# IDEs
+#/.vscode
+#omnisharp.json
+#.editorconfig

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Dependencies/websocket-sharp"]
+	path = Dependencies/websocket-sharp
+	url = https://github.com/sta/websocket-sharp

Dependencies/websocket-sharp

@@ -0,0 +1,11 @@
+using System;
+
+namespace UnityWebSocket {
+  public class DataEventArgs : EventArgs {
+    public byte[] Data { get; private set; }
+
+    public DataEventArgs(byte[] data) {
+      this.Data = data;
+    }
+  }
+}

Events/DataEventArgs.cs

@@ -0,0 +1,11 @@
+using System;
+
+namespace UnityWebSocket {
+  public class TextEventArgs : EventArgs {
+    public string Text { get; private set; }
+
+    public TextEventArgs(string text) {
+      this.Text = text;
+    }
+  }
+}

Events/TextEventArgs.cs

@@ -0,0 +1,40 @@
+using System.Collections;
+using System.Collections.Generic;
+using System.Text;
+using UnityEngine;
+using UnityEngine.Events;
+using System;
+
+// This handler takes the web socket data bytes and raises a received data event.
+// This allows us to parse the bytes data in one place and then raise an event to feed game object recievers or a controller to target multiple game objects.
+namespace UnityWebSocket {
+  public abstract class DataHandler : MonoBehaviour, IDataHandler {
+    // A game object can implement this received data event to get updates.
+    public delegate void ReceivedData(object sender, EventArgs e);
+    public static event ReceivedData OnReceivedData;
+
+    // Override this method in your own subclass to pass any custom event args
+    public virtual void OnData(byte[] data) {
+      Debug.LogFormat("Received data:\n{0}", data.Length);
+      RaiseOnReceivedData(this, new DataEventArgs(data));
+    }
+
+    protected void RaiseOnReceivedData(object sender, EventArgs e) {
+      // Raise the event
+      OnReceivedData(this, e);
+    }
+
+    #region Unity lifecycle
+
+    // Web Socket data handler
+    void OnEnable() {
+      UnityWebSocket.OnData += OnData;
+    }
+
+    void OnDisable() {
+      UnityWebSocket.OnData -= OnData;
+    }
+
+    #endregion
+  }
+}

Handlers/DataHandler.cs

@@ -0,0 +1,9 @@
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace UnityWebSocket {
+  public interface IDataHandler {
+    void OnData(byte[] data);
+  }
+}

Handlers/IDataHandler.cs

@@ -0,0 +1,15 @@
+
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using System.Text;
+using System;
+
+namespace UnityWebSocket {
+  public class TextHandler : DataHandler {
+    // Web Socket handler passes text event args
+    public override void OnData(byte[] data) {
+      RaiseOnReceivedData(this, new TextEventArgs(Encoding.UTF8.GetString(data)));
+    }
+  }
+}

Handlers/TextHandler.cs

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 David Douglas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -0,0 +1,29 @@
+# Web Sockets for Unity
+
+For Unity developers looking to use Web Sockets in their Unity game / app.
+
+## External dependencies
+**First download the required dependencies and extract the contents into your Unity project "Assets" folder.**
+- [WebSocket-Sharp](https://github.com/sta/websocket-sharp)
+
+## :octocat: Download instructions
+This project contains git submodule dependencies so use:
+
+    `git clone --recursive https://github.com/Unity3dAzure/UnityWebSocket.git`
+
+Or if you've already done a git clone then use:
+
+    `git submodule update --init --recursive`
+
+## 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:
+
+```
+ObjectDisposedException: Cannot access a disposed object.
+Object name: 'System.Net.Sockets.NetworkStream'
+```
+
+Therefore I opted for [WebSocket-Sharp](https://github.com/sta/websocket-sharp) which targets .NET Framework 3.5 and works in the Unity 2017 editor and doesn't seem to have the same issue.
+
+Questions or tweet [@deadlyfingers](https://twitter.com/deadlyfingers)

README.md

@@ -0,0 +1,26 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+
+namespace UnityWebSocket {
+  public abstract class DataReceiver : MonoBehaviour, IDataReceiver {
+
+    // Override this method in your own subclass to process the received event data
+    virtual public void OnReceivedData(object sender, EventArgs args) {
+      Debug.Log("Hey we got some bytes to do something with!");
+    }
+
+    #region Unity lifecycle
+
+    virtual public void OnEnable() {
+      DataHandler.OnReceivedData += OnReceivedData;
+    }
+
+    virtual public void OnDisable() {
+      DataHandler.OnReceivedData -= OnReceivedData;
+    }
+
+    #endregion
+  }
+}

Receivers/DataReceiver.cs

@@ -0,0 +1,7 @@
+using System;
+
+namespace UnityWebSocket {
+  public interface IDataReceiver {
+    void OnReceivedData(object sender, EventArgs args);
+  }
+}

Receivers/IDataReceiver.cs

@@ -0,0 +1,44 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using UnityEngine.UI;
+
+namespace UnityWebSocket {
+  // Drop this script onto a TextMesh gameobject to make it update
+  public class TextMeshReceiver : DataReceiver {
+
+    private string text;
+    private TextMesh textMesh;
+    private bool needsUpdated = false;
+
+    void Awake() {
+      textMesh = gameObject.GetComponent<TextMesh>();
+    }
+
+    void Update() {
+      // update any text components on this gameobject
+      if (textMesh != null) {
+        textMesh.text = text;
+        needsUpdated = false;
+      }
+    }
+
+    // Override this method in your own subclass to process the received event data
+    override public void OnReceivedData(object sender, EventArgs args) {
+      if (args == null) {
+        return;
+      }
+
+      // return early if wrong type of EventArgs
+      var myArgs = args as TextEventArgs;
+      if (myArgs == null) {
+        return;
+      }
+
+      text = myArgs.Text;
+      needsUpdated = true;
+    }
+  }
+
+}

Receivers/TextMeshReceiver.cs

@@ -0,0 +1,113 @@
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using UnityEngine;
+using WebSocketSharp;
+using System.Text;
+using UnityEngine.UI;
+
+namespace UnityWebSocket {
+  public class UnityWebSocket : MonoBehaviour {
+    // Web Socket data delegate
+    public delegate void Data(byte[] data);
+    public static Data OnData;
+
+    // Unity Inspector fields
+    [SerializeField]
+    private string webSocketUri = "ws://127.0.0.1:8080";
+    [SerializeField]
+    private bool AutoConnect = false;
+
+    private WebSocket _ws;
+    private bool isReady = false;
+
+    void OnEnable() {
+      if (AutoConnect) {
+        ConnectWebSocket();
+      }
+    }
+
+    void OnDisable() {
+      DisconnectWebSocket();
+    }
+
+    public void Connect() {
+      ConnectWebSocket();
+    }
+
+    public void Close() {
+      DisconnectWebSocket();
+    }
+
+    public void SendText(string text) {
+      byte[] data = Encoding.UTF8.GetBytes(text);
+      SendBytes(data, null);
+    }
+
+    public void SendInputText(InputField inputField) {
+      SendText(inputField.text);
+    }
+
+    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?");
+        return;
+      }
+      _ws.SendAsync(data, callback);
+    }
+
+    private void ConnectWebSocket() {
+      if (_ws == null) {
+        Debug.Log("Create web socket uri: " + webSocketUri);
+        _ws = new WebSocket(webSocketUri);
+      }
+
+      if (!isReady) {
+        Debug.Log("Connect web socket");
+        isReady = true;
+        _ws.OnError += OnWebSocketError;
+        _ws.OnOpen += OnWebSocketOpen;
+        _ws.OnMessage += OnWebSocketMessage;
+        _ws.OnClose += OnWebSocketClose;
+        _ws.ConnectAsync();
+      }
+    }
+
+    private void DisconnectWebSocket() {
+      if (_ws != null && isReady) {
+        Debug.Log("Disconnect web socket");
+        _ws.CloseAsync();
+        _ws.OnError -= OnWebSocketError;
+        _ws.OnOpen -= OnWebSocketOpen;
+        _ws.OnMessage -= OnWebSocketMessage;
+        _ws.OnClose -= OnWebSocketClose;
+        isReady = false;
+      }
+    }
+
+    private void OnWebSocketOpen(object sender, EventArgs e) {
+      Debug.Log("Web socket is open");
+    }
+
+    private void OnWebSocketClose(object sender, CloseEventArgs e) {
+      Debug.Log("Web socket closed with reason: " + e.Reason);
+      if (!e.WasClean) {
+        DisconnectWebSocket();
+      }
+    }
+
+    private void OnWebSocketMessage(object sender, MessageEventArgs e) {
+      Debug.Log("Web socket message:\n" + e.Data);
+      // Raise web socket data handler event
+      OnData(e.RawData);
+    }
+
+    private void OnWebSocketError(object sender, ErrorEventArgs e) {
+      Debug.LogError("Web socket error: " + e.Message);
+      DisconnectWebSocket();
+    }
+
+  }
+
+}
+