Fix open/close events not called on main thread

Author: shaunabanana

Assets/MyWebSocketServer.cs

@@ -24,8 +24,16 @@ override public void OnClose(WebSocketConnection connection) {
         // Here is the same as OnOpen
         Debug.Log(connection.id);
     }
+    
+    public void onConnectionOpened (WebSocketConnection connection) {
+        Debug.Log("Connection opened: " + connection.id);
+    }
 
     public void onMessageReceived (WebSocketMessage message) {
         Debug.Log("Received new message: " + message.data);
     }
+
+    public void onConnectionClosed (WebSocketConnection connection) {
+        Debug.Log("Connection closed: " + connection.id);
+    }
 }

Assets/Scenes/SampleScene.unity

@@ -239,7 +239,19 @@ MonoBehaviour:
   port: 8175
   onOpen:
     m_PersistentCalls:
-      m_Calls: []
+      m_Calls:
+      - m_Target: {fileID: 944133942}
+        m_TargetAssemblyTypeName: MyWebSocketServer, Assembly-CSharp
+        m_MethodName: onConnectionOpened
+        m_Mode: 0
+        m_Arguments:
+          m_ObjectArgument: {fileID: 0}
+          m_ObjectArgumentAssemblyTypeName: UnityEngine.Object, UnityEngine
+          m_IntArgument: 0
+          m_FloatArgument: 0
+          m_StringArgument: 
+          m_BoolArgument: 0
+        m_CallState: 2
   onMessage:
     m_PersistentCalls:
       m_Calls:
@@ -257,7 +269,19 @@ MonoBehaviour:
         m_CallState: 2
   onClose:
     m_PersistentCalls:
-      m_Calls: []
+      m_Calls:
+      - m_Target: {fileID: 944133942}
+        m_TargetAssemblyTypeName: MyWebSocketServer, Assembly-CSharp
+        m_MethodName: onConnectionClosed
+        m_Mode: 0
+        m_Arguments:
+          m_ObjectArgument: {fileID: 0}
+          m_ObjectArgumentAssemblyTypeName: UnityEngine.Object, UnityEngine
+          m_IntArgument: 0
+          m_FloatArgument: 0
+          m_StringArgument: 
+          m_BoolArgument: 0
+        m_CallState: 2
 --- !u!4 &944133943
 Transform:
   m_ObjectHideFlags: 0

Assets/WebSocketServer/WebSocketConnection.cs

@@ -13,6 +13,12 @@
 
 namespace WebSocketServer {
 
+    public enum WebSocketEventType {
+        Open,
+        Close,
+        Message
+    }
+
     public struct WebSocketMessage {
         public WebSocketMessage(WebSocketConnection connection, string data) {
             this.id = Guid.NewGuid().ToString();
@@ -25,6 +31,20 @@ public WebSocketMessage(WebSocketConnection connection, string data) {
         public string data { get; }
     }
 
+    public struct WebSocketEvent {
+        public WebSocketEvent(WebSocketConnection connection, WebSocketEventType type, string data) {
+            this.id = Guid.NewGuid().ToString();
+            this.connection = connection;
+            this.type = type;
+            this.data = data;
+        }
+
+        public string id { get; }
+        public WebSocketEventType type { get; }
+        public WebSocketConnection connection { get; }
+        public string data { get; }
+    }
+
     public class WebSocketConnection {
 
         public string id;
@@ -63,8 +83,8 @@ public bool Establish() {
                 connectionHandler.Start();
 
                 // Call the server callback.
-                server.onOpen.Invoke(this);
-                server.OnOpen(this);
+                WebSocketEvent wsEvent = new WebSocketEvent(this, WebSocketEventType.Open, null);
+                server.events.Enqueue(wsEvent);
                 return true;
             } else {
                 return false;
@@ -79,17 +99,17 @@ private void HandleConnection () {
                     if ((WebSocketOpCode)dataframe.opcode == WebSocketOpCode.Text) {
                         // Let the server know of the message.
                         string data = WebSocketProtocol.DecodeText(dataframe);
-                        WebSocketMessage message = new WebSocketMessage(this, data);
-                        server.messages.Enqueue(message);
+                        WebSocketEvent wsEvent = new WebSocketEvent(this, WebSocketEventType.Message, data);
+                        server.events.Enqueue(wsEvent);
                     } else if ((WebSocketOpCode)dataframe.opcode == WebSocketOpCode.Close) {
                         // Handle closing the connection.
                         Debug.Log("Client closed the connection.");
                         // Close the connection.
                         stream.Close();
                         client.Close();
                         // Call server callback.
-                        server.onClose.Invoke(this);
-                        server.OnClose(this);
+                        WebSocketEvent wsEvent = new WebSocketEvent(this, WebSocketEventType.Close, null);
+                        server.events.Enqueue(wsEvent);
                         // Jump out of the loop.
                         break;
                     }

Assets/WebSocketServer/WebSocketServer.cs

@@ -29,7 +29,7 @@ public class WebSocketServer : MonoBehaviour
         private List<Thread> workerThreads;
         private TcpClient connectedTcpClient;
 
-        public ConcurrentQueue<WebSocketMessage> messages;
+        public ConcurrentQueue<WebSocketEvent> events;
 
         public string address;
         public int port;
@@ -42,7 +42,7 @@ void Awake() {
         }
 
         void Start() {
-            messages = new ConcurrentQueue<WebSocketMessage>();
+            events = new ConcurrentQueue<WebSocketEvent>();
             workerThreads = new List<Thread>();
 
             tcpListenerThread = new Thread (new ThreadStart(ListenForTcpConnection));
@@ -51,10 +51,19 @@ void Start() {
         }
 
         void Update() {
-            WebSocketMessage message;
-            while (messages.TryDequeue(out message)) {
-                onMessage.Invoke(message);
-                this.OnMessage(message);
+            WebSocketEvent wsEvent;
+            while (events.TryDequeue(out wsEvent)) {
+                if (wsEvent.type == WebSocketEventType.Open) {
+                    onOpen.Invoke(wsEvent.connection);
+                    this.OnOpen(wsEvent.connection);
+                } else if (wsEvent.type == WebSocketEventType.Close) {
+                    onClose.Invoke(wsEvent.connection);
+                    this.OnClose(wsEvent.connection);
+                } else if (wsEvent.type == WebSocketEventType.Message) {
+                    WebSocketMessage message = new WebSocketMessage(wsEvent.connection, wsEvent.data);
+                    onMessage.Invoke(message);
+                    this.OnMessage(message);
+                }
             }
         }
 

Logs/ApiUpdaterCheck.txt

@@ -438,3 +438,33 @@ C# parse time         : 221ms
 candidates check time : 42ms
 console write time    : 0ms
 
+[api-updater (non-obsolete-error-filter)] 4/30/2022 8:20:48 PM : Starting /Applications/Unity/Hub/Editor/2020.3.16f1/Unity.app/Contents/Tools/ScriptUpdater/APIUpdater.NonObsoleteApiUpdaterDetector.exe
+[api-updater (non-obsolete-error-filter)] 
+----------------------------------
+jit/startup time      : 1426.16ms
+moved types parse time: 148ms
+candidates parse time : 5ms
+C# parse time         : 472ms
+candidates check time : 157ms
+console write time    : 1ms
+
+[api-updater (non-obsolete-error-filter)] 4/30/2022 8:25:44 PM : Starting /Applications/Unity/Hub/Editor/2020.3.16f1/Unity.app/Contents/Tools/ScriptUpdater/APIUpdater.NonObsoleteApiUpdaterDetector.exe
+[api-updater (non-obsolete-error-filter)] 
+----------------------------------
+jit/startup time      : 155.097ms
+moved types parse time: 156ms
+candidates parse time : 6ms
+C# parse time         : 540ms
+candidates check time : 131ms
+console write time    : 1ms
+
+[api-updater (non-obsolete-error-filter)] 4/30/2022 8:26:40 PM : Starting /Applications/Unity/Hub/Editor/2020.3.16f1/Unity.app/Contents/Tools/ScriptUpdater/APIUpdater.NonObsoleteApiUpdaterDetector.exe
+[api-updater (non-obsolete-error-filter)] 
+----------------------------------
+jit/startup time      : 157.439ms
+moved types parse time: 160ms
+candidates parse time : 7ms
+C# parse time         : 511ms
+candidates check time : 120ms
+console write time    : 1ms
+