com.xmobitea.changx.gn-unity 2.0.3 → 2.4.0

package/Runtime/Networking/Socket/SocketPeer.cs

@@ -1,199 +1,244 @@
-namespace XmobiTea.GN.Networking.Socket
-{
-    using System;
-    using System.Collections.Generic;
-    using System.Linq;
-    using XmobiTea.GN.Common;
-    using XmobiTea.GN.Config;
-    using XmobiTea.GN.Entity;
-    using XmobiTea.GN.Logger;
-
-    internal class SocketPeer : PeerBase
-    {
-        private NetworkingSocketPeerBase networkingSocketPeerBase;
-
-
-        private Dictionary<int, List<IServerEventHandler>> serverEventHandlersDict;
-
-        private Action<OperationEvent> _onEventHandler;
-
-        internal string getClientId()
-        {
-            return this.networkingSocketPeerBase?.clientId;
-        }
-
-        internal bool isConnected()
-        {
-            return this.networkingSocketPeerBase.isWsConnected;
-        }
-
-        internal void sendRequestAuthSocket()
-        {
-            this.networkingSocketPeerBase.sendRequestAuthSocket();
-        }
-
-        void subscriberServerEventHandler()
-        {
-            if (this.serverEventHandlersDict == null) this.serverEventHandlersDict = new Dictionary<int, List<IServerEventHandler>>();
-            else this.serverEventHandlersDict.Clear();
-
-            var type = typeof(IServerEventHandler);
-            var types = AppDomain.CurrentDomain.GetAssemblies()
-                .SelectMany(s => s.GetTypes())
-                .Where(p => type.IsAssignableFrom(p) && p != type).ToList();
-
-            foreach (var t in types)
-            {
-                var srvMsg = Activator.CreateInstance(t) as IServerEventHandler;
-                if (srvMsg != null)
-                {
-                    List<IServerEventHandler> serverEventHandlers;
-
-                    if (!this.serverEventHandlersDict.ContainsKey(srvMsg.getEventCode()))
-                    {
-                        serverEventHandlers = new List<IServerEventHandler>();
-
-                        this.serverEventHandlersDict[srvMsg.getEventCode()] = serverEventHandlers;
-                    }
-                    else
-                    {
-                        serverEventHandlers = this.serverEventHandlersDict[srvMsg.getEventCode()];
-                    }
-
-                    serverEventHandlers.Add(srvMsg);
-                }
-            }
-        }
-
-        internal override void initGNSocketObject()
-        {
-            var gnServerSettings = GNNetwork.gnServerSettings;
-            if (gnServerSettings == null) throw new NullReferenceException("Where is GN Server Settings");
-
-            this.isUse = gnServerSettings.isUseSocket();
-
-            var peerSocketVersion = gnServerSettings.getPeerSocketVersion();
-
-            if (peerSocketVersion == PeerSocketVersion.V3)
+namespace XmobiTea.GN.Networking.Socket
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Linq;
+    using XmobiTea.GN.Common;
+    using XmobiTea.GN.Config;
+    using XmobiTea.GN.Entity;
+    using XmobiTea.GN.Logger;
+
+    /// <summary>
+    /// Manages socket communication for the application.
+    /// </summary>
+    internal class SocketPeer : PeerBase
+    {
+        private NetworkingSocketPeerBase networkingSocketPeerBase;
+        private Dictionary<int, List<IServerEventHandler>> serverEventHandlersDict;
+        private Action<OperationEvent> _onEventHandler;
+
+        /// <summary>
+        /// Gets the client ID of the socket connection.
+        /// </summary>
+        /// <returns>The client ID as a string.</returns>
+        internal string getClientId()
+        {
+            return this.networkingSocketPeerBase?.clientId;
+        }
+
+        /// <summary>
+        /// Checks if the socket connection is established.
+        /// </summary>
+        /// <returns>True if connected, otherwise false.</returns>
+        internal bool isConnected()
+        {
+            return this.networkingSocketPeerBase.isWsConnected;
+        }
+
+        /// <summary>
+        /// Sends an authentication request via the socket.
+        /// </summary>
+        internal void sendRequestAuthSocket()
+        {
+            this.networkingSocketPeerBase.sendRequestAuthSocket();
+        }
+
+        /// <summary>
+        /// Subscribes server event handlers by scanning the current assembly.
+        /// </summary>
+        void subscriberServerEventHandler()
+        {
+            if (this.serverEventHandlersDict == null)
+                this.serverEventHandlersDict = new Dictionary<int, List<IServerEventHandler>>();
+            else
+                this.serverEventHandlersDict.Clear();
+
+            var type = typeof(IServerEventHandler);
+            var types = AppDomain.CurrentDomain.GetAssemblies()
+                .SelectMany(s => s.GetTypes())
+                .Where(p => type.IsAssignableFrom(p) && p != type).ToList();
+
+            foreach (var t in types)
             {
-#if UNITY_USING_BEST_HTTP
-                this.networkingSocketPeerBase = new NetworkingPeerSocketV3();
-#endif
-            }
-            else
+                var srvMsg = Activator.CreateInstance(t) as IServerEventHandler;
+                if (srvMsg != null)
+                {
+                    List<IServerEventHandler> serverEventHandlers;
+
+                    if (!this.serverEventHandlersDict.ContainsKey(srvMsg.getEventCode()))
+                    {
+                        serverEventHandlers = new List<IServerEventHandler>();
+
+                        this.serverEventHandlersDict[srvMsg.getEventCode()] = serverEventHandlers;
+                    }
+                    else
+                    {
+                        serverEventHandlers = this.serverEventHandlersDict[srvMsg.getEventCode()];
+                    }
+
+                    serverEventHandlers.Add(srvMsg);
+                }
+            }
+        }
+
+        /// <summary>
+        /// Initializes the socket object with server settings.
+        /// </summary>
+        internal override void initGNSocketObject()
+        {
+            var gnServerSettings = GNNetwork.gnServerSettings;
+            if (gnServerSettings == null) throw new NullReferenceException("Where is GN Server Settings");
+
+            this.isUse = gnServerSettings.isUseSocket();
+
+            var peerSocketVersion = gnServerSettings.getPeerSocketVersion();
+
+            if (peerSocketVersion == PeerSocketVersion.V3)
             {
-#if UNITY_USING_BEST_HTTP
-                this.networkingSocketPeerBase = new NetworkingPeerSocketV2();
-
-                if (peerSocketVersion == PeerSocketVersion.V2_v2)
-                {
-                    ((NetworkingPeerSocketV2)this.networkingSocketPeerBase).setServerVersion(BestHTTP.SocketIO.SupportedSocketIOVersions.v2);
-                }
-                else if (peerSocketVersion == PeerSocketVersion.V2_v3)
-                {
-                    ((NetworkingPeerSocketV2)this.networkingSocketPeerBase).setServerVersion(BestHTTP.SocketIO.SupportedSocketIOVersions.v3);
-                }
-#endif
-            }
-
-            if (this.networkingSocketPeerBase == null) throw new NullReferenceException("this.networkingSocketPeerBase null");
-
-            this.networkingSocketPeerBase.init(gnServerSettings.getSocketUrl(), gnServerSettings.getReconnectDelay(), gnServerSettings.getPingInterval(), gnServerSettings.getPingTimeout());
-            this.networkingSocketPeerBase.reInitNewSocket();
-
-            this.networkingSocketPeerBase.setOnEventHandler(this.onEventHandler);
-            this.networkingSocketPeerBase.setOnResponseHandler(this.onResponseHandler);
-
-            this.subscriberServerEventHandler();
-        }
-
-        internal void setOnConnectHandler(Action _onConnectHandler)
-        {
-            this.networkingSocketPeerBase.setOnConnectHandler(_onConnectHandler);
-        }
-
-        internal void setOnDisconnectHandler(Action _onDisconnectHandler)
-        {
-            this.networkingSocketPeerBase.setOnDisconnectHandler(_onDisconnectHandler);
-        }
-
-        internal void removeOnConnectHandler(Action _onConnectHandler)
-        {
-            this.networkingSocketPeerBase.removeOnConnectHandler(_onConnectHandler);
-        }
-
-        internal void removeOnDisconnectHandler(Action _onDisconnectHandler)
-        {
-            this.networkingSocketPeerBase.removeOnDisconnectHandler(_onDisconnectHandler);
-        }
-
-        internal void connect(Action _onSocketConnect)
-        {
-            this.networkingSocketPeerBase.connect(_onSocketConnect);
-        }
-
-        internal void disconnect(Action _onSocketDisconnect)
-        {
-            this.networkingSocketPeerBase.close(_onSocketDisconnect);
-        }
-
-        internal void setOnEventHandler(Action<OperationEvent> _onEventHandler)
-        {
-            this._onEventHandler = _onEventHandler;
-        }
-
-        internal override void send(OperationPending operationPending)
-        {
-            base.send(operationPending);
-
-            GNDebug.log("[GN Socket SEND] " + operationPending.getOperationRequest().ToString());
-
-            var authToken = operationPending.getAuthToken();
-            var secretKey = operationPending.getSecretKey();
-            var customTags = operationPending.getCustomTags();
-
-            this.networkingSocketPeerBase.Send(operationPending.getRequestType(), operationPending.getRequestRole(), operationPending.getOperationRequest(), authToken, secretKey, customTags);
-        }
-
-        internal void onEventHandler(GNArray obj, bool isEncrypted)
-        {
-            var eventCode = obj.getInt(0);
-
-            var operationEvent = new OperationEvent(eventCode, obj.getGNHashtable(1));
-            operationEvent.setEncrypted(isEncrypted);
-
-            GNDebug.log("[GN Socket EVENT] " + operationEvent.toString());
-
-            this._onEventHandler?.Invoke(operationEvent);
-
-            if (!this.serverEventHandlersDict.ContainsKey(eventCode))
-            {
-                return;
-            }
-
-            var serverEventHandlers = this.serverEventHandlersDict[eventCode];
-
-            foreach (var serverEventHandler in serverEventHandlers)
-                serverEventHandler.handle(operationEvent);
-        }
-
-        public override void service()
-        {
-            base.service();
-
-            this.networkingSocketPeerBase?.service();
-        }
-
-        //internal static string Auth(BestHTTP.SocketIO3.SocketManager socketManager, BestHTTP.SocketIO3.Socket socket)
-        //{
-        //    return authTokenFormat.Replace("$authtoken", GNNetwork.authToken);
-        //}
-
-        //internal static string Auth(BestHTTP.SocketIO.SocketManager socketManager, BestHTTP.SocketIO.Socket socket)
-        //{
-        //    return authTokenFormat.Replace("$authtoken", GNNetwork.authToken);
-        //}
-
-    }
-
-}
+#if UNITY_USING_BEST_HTTP
+                this.networkingSocketPeerBase = new NetworkingPeerSocketV3();
+#endif
+            }
+            else
+            {
+#if UNITY_USING_BEST_HTTP
+                this.networkingSocketPeerBase = new NetworkingPeerSocketV2();
+
+                if (peerSocketVersion == PeerSocketVersion.V2_v2)
+                {
+                    ((NetworkingPeerSocketV2)this.networkingSocketPeerBase).setServerVersion(BestHTTP.SocketIO.SupportedSocketIOVersions.v2);
+                }
+                else if (peerSocketVersion == PeerSocketVersion.V2_v3)
+                {
+                    ((NetworkingPeerSocketV2)this.networkingSocketPeerBase).setServerVersion(BestHTTP.SocketIO.SupportedSocketIOVersions.v3);
+                }
+#endif
+            }
+
+            if (this.networkingSocketPeerBase == null) throw new NullReferenceException("this.networkingSocketPeerBase null");
+
+            this.networkingSocketPeerBase.init(gnServerSettings.getSocketUrl(), gnServerSettings.getReconnectDelay(), gnServerSettings.getPingInterval(), gnServerSettings.getPingTimeout());
+            this.networkingSocketPeerBase.reInitNewSocket();
+
+            this.networkingSocketPeerBase.setOnEventHandler(this.onEventHandler);
+            this.networkingSocketPeerBase.setOnResponseHandler(this.onResponseHandler);
+
+            this.subscriberServerEventHandler();
+        }
+
+        /// <summary>
+        /// Sets a callback for when the socket connects.
+        /// </summary>
+        internal void setOnConnectHandler(Action _onConnectHandler)
+        {
+            this.networkingSocketPeerBase.setOnConnectHandler(_onConnectHandler);
+        }
+
+        /// <summary>
+        /// Sets a callback for when the socket disconnects.
+        /// </summary>
+        internal void setOnDisconnectHandler(Action _onDisconnectHandler)
+        {
+            this.networkingSocketPeerBase.setOnDisconnectHandler(_onDisconnectHandler);
+        }
+
+        /// <summary>
+        /// Removes the connection callback.
+        /// </summary>
+        internal void removeOnConnectHandler(Action _onConnectHandler)
+        {
+            this.networkingSocketPeerBase.removeOnConnectHandler(_onConnectHandler);
+        }
+
+        /// <summary>
+        /// Removes the disconnection callback.
+        /// </summary>
+        internal void removeOnDisconnectHandler(Action _onDisconnectHandler)
+        {
+            this.networkingSocketPeerBase.removeOnDisconnectHandler(_onDisconnectHandler);
+        }
+
+        /// <summary>
+        /// Connects the socket with a specified callback.
+        /// </summary>
+        internal void connect(Action _onSocketConnect)
+        {
+            this.networkingSocketPeerBase.connect(_onSocketConnect);
+        }
+
+        /// <summary>
+        /// Disconnects the socket with a specified callback.
+        /// </summary>
+        internal void disconnect(Action _onSocketDisconnect)
+        {
+            this.networkingSocketPeerBase.close(_onSocketDisconnect);
+        }
+
+        /// <summary>
+        /// Sets the event handler for incoming socket events.
+        /// </summary>
+        internal void setOnEventHandler(Action<OperationEvent> _onEventHandler)
+        {
+            this._onEventHandler = _onEventHandler;
+        }
+
+        /// <summary>
+        /// Sends an operation request via the socket.
+        /// </summary>
+        internal override void send(OperationPending operationPending)
+        {
+            base.send(operationPending);
+
+            GNDebug.log("[GN Socket SEND] " + operationPending.getOperationRequest().ToString());
+
+            var authToken = operationPending.getAuthToken();
+            var secretKey = operationPending.getSecretKey();
+            var gameId = operationPending.getGameId();
+            var customTags = operationPending.getCustomTags();
+
+            this.networkingSocketPeerBase.Send(operationPending.getRequestType(), operationPending.getRequestRole(), operationPending.getOperationRequest(), authToken, secretKey, customTags, gameId);
+        }
+
+        /// <summary>
+        /// Handles incoming socket events and invokes appropriate handlers.
+        /// </summary>
+        internal void onEventHandler(GNArray obj, bool isEncrypted)
+        {
+            var eventCode = obj.getInt(0);
+
+            var operationEvent = new OperationEvent(eventCode, obj.getGNHashtable(1));
+            operationEvent.setEncrypted(isEncrypted);
+
+            GNDebug.log("[GN Socket EVENT] " + operationEvent.toString());
+
+            this._onEventHandler?.Invoke(operationEvent);
+
+            if (!this.serverEventHandlersDict.ContainsKey(eventCode)) return;
+
+            var serverEventHandlers = this.serverEventHandlersDict[eventCode];
+
+            foreach (var serverEventHandler in serverEventHandlers)
+                serverEventHandler.handle(operationEvent);
+        }
+
+        /// <summary>
+        /// Processes socket service operations.
+        /// </summary>
+        public override void service()
+        {
+            base.service();
+            this.networkingSocketPeerBase?.service();
+        }
+
+        //internal static string Auth(BestHTTP.SocketIO3.SocketManager socketManager, BestHTTP.SocketIO3.Socket socket)
+        //{
+        //    return authTokenFormat.Replace("$authtoken", GNNetwork.authToken);
+        //}
+
+        //internal static string Auth(BestHTTP.SocketIO.SocketManager socketManager, BestHTTP.SocketIO.Socket socket)
+        //{
+        //    return authTokenFormat.Replace("$authtoken", GNNetwork.authToken);
+        //}
+
+    }
+}

package/Runtime/Networking/Socket/SocketPeer.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 138a4e1d48a3d2f47afac60685c8f2f0
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 138a4e1d48a3d2f47afac60685c8f2f0
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Networking/Socket.meta

@@ -1,8 +1,8 @@
-fileFormatVersion: 2
-guid: 072aeea0e87803c4cad987251dbec2f4
-folderAsset: yes
-DefaultImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 072aeea0e87803c4cad987251dbec2f4
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Networking.meta

@@ -1,8 +1,8 @@
-fileFormatVersion: 2
-guid: 39e70e9a43268c543b8b066ca0e74205
-folderAsset: yes
-DefaultImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 39e70e9a43268c543b8b066ca0e74205
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/ServiceCoroutine.cs

@@ -0,0 +1,10 @@
+namespace XmobiTea.GN.Unity
+{
+    /// <summary>
+    /// The ServiceCoroutine class is responsible for updating and handling coroutine.
+    /// </summary>
+    internal class ServiceCoroutine : UnityEngine.MonoBehaviour
+    {
+
+    }
+}

package/Runtime/Unity/ServiceCoroutine.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: ca6afd49457b28042961edb32d42fc12
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity/ServiceUpdate.cs

@@ -1,20 +1,33 @@
-namespace XmobiTea.GN.Unity
-{
-    using XmobiTea.GN.Networking;
-
-    internal class ServiceUpdate : UnityEngine.MonoBehaviour
-    {
-        internal NetworkingPeer peer;
-
-        private void update()
-        {
-            this.peer?.service();
-        }
-
-        void Update()
-        {
-            this.update();
-        }
-    }
-
-}
+namespace XmobiTea.GN.Unity
+{
+    using XmobiTea.GN.Networking;
+
+    /// <summary>
+    /// The ServiceUpdate class is responsible for updating and handling network services.
+    /// </summary>
+    internal class ServiceUpdate : UnityEngine.MonoBehaviour
+    {
+        /// <summary>
+        /// The NetworkingPeer instance used to perform network operations.
+        /// </summary>
+        internal NetworkingPeer peer;
+
+        /// <summary>
+        /// Handles the logic to update the network service.
+        /// </summary>
+        private void update()
+        {
+            // Calls the service() method of the peer object if it is not null.
+            this.peer?.service();
+        }
+
+        /// <summary>
+        /// Unity's Update method, called once per frame.
+        /// </summary>
+        void Update()
+        {
+            // Invokes the custom update() method to handle network logic.
+            this.update();
+        }
+    }
+}

package/Runtime/Unity/ServiceUpdate.cs.meta

@@ -1,11 +1,11 @@
-fileFormatVersion: 2
-guid: 535d48a60a02ae14d83f19e9a749983b
-MonoImporter:
-  externalObjects: {}
-  serializedVersion: 2
-  defaultReferences: []
-  executionOrder: 0
-  icon: {instanceID: 0}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 535d48a60a02ae14d83f19e9a749983b
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/Unity.meta

@@ -1,8 +1,8 @@
-fileFormatVersion: 2
-guid: 58c343c317839a5469f8ff68787ae561
-folderAsset: yes
-DefaultImporter:
-  externalObjects: {}
-  userData: 
-  assetBundleName: 
-  assetBundleVariant: 
+fileFormatVersion: 2
+guid: 58c343c317839a5469f8ff68787ae561
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Runtime/XmobiTea.GN.runtime.asmdef

@@ -1,17 +1,17 @@
-{
-    "name": "XmobiTea.GN.runtime",
-    "rootNamespace": "",
-    "references": [
-        "BestHTTP",
-        "XmobiTea.MsgPack.runtime"
-    ],
-    "includePlatforms": [],
-    "excludePlatforms": [],
-    "allowUnsafeCode": false,
-    "overrideReferences": false,
-    "precompiledReferences": [],
-    "autoReferenced": true,
-    "defineConstraints": [],
-    "versionDefines": [],
-    "noEngineReferences": false
+{
+    "name": "XmobiTea.GN.runtime",
+    "rootNamespace": "",
+    "references": [
+        "BestHTTP",
+        "XmobiTea.MsgPack.runtime"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
 }