com.xmobitea.changx.gn-unity 2.0.2 → 2.3.0

package/Runtime/Networking/Socket/SocketPeer.cs

@@ -8,34 +8,50 @@
     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();
+            if (this.serverEventHandlersDict == null)
+                this.serverEventHandlersDict = new Dictionary<int, List<IServerEventHandler>>();
+            else
+                this.serverEventHandlersDict.Clear();
 
             var type = typeof(IServerEventHandler);
             var types = AppDomain.CurrentDomain.GetAssemblies()
@@ -65,6 +81,9 @@
             }
         }
 
+        /// <summary>
+        /// Initializes the socket object with server settings.
+        /// </summary>
         internal override void initGNSocketObject()
         {
             var gnServerSettings = GNNetwork.gnServerSettings;
@@ -76,10 +95,13 @@
 
             if (peerSocketVersion == PeerSocketVersion.V3)
             {
+#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)
@@ -90,8 +112,11 @@
                 {
                     ((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();
 
@@ -101,41 +126,65 @@
             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);
@@ -144,11 +193,15 @@
 
             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);
+            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);
@@ -160,10 +213,7 @@
 
             this._onEventHandler?.Invoke(operationEvent);
 
-            if (!this.serverEventHandlersDict.ContainsKey(eventCode))
-            {
-                return;
-            }
+            if (!this.serverEventHandlersDict.ContainsKey(eventCode)) return;
 
             var serverEventHandlers = this.serverEventHandlersDict[eventCode];
 
@@ -171,10 +221,12 @@
                 serverEventHandler.handle(operationEvent);
         }
 
+        /// <summary>
+        /// Processes socket service operations.
+        /// </summary>
         public override void service()
         {
             base.service();
-
             this.networkingSocketPeerBase?.service();
         }
 
@@ -189,5 +241,4 @@
         //}
 
     }
-
 }

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

@@ -2,19 +2,32 @@ 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.xmobitea.changx.gn-unity",
-  "version": "2.0.2",
+  "version": "2.3.0",
   "displayName": "XmobiTea GN Unity",
   "description": "XmobiTea Unity packages",
   "unity": "2020.3",