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

package/Runtime/Networking/OperationPending.cs

@@ -5,21 +5,35 @@ namespace XmobiTea.GN.Networking
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Entity;
 
+    /// <summary>
+    /// Represents a pending operation request, including metadata and timing information.
+    /// </summary>
     public struct OperationPending
     {
-        private OperationRequest operationRequest;
-        private RequestType requestType;
-        private RequestRole requestRole;
-        private string authToken;
-        private string secretKey;
-        private GNHashtable customTags;
-        private Action<OperationResponse> onOperationResponse;
-        private float timeout;
-
-        private float firstSend;
-        private float secondsSend;
-
-        public OperationPending(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, Action<OperationResponse> onOperationResponse, string authToken, string secretKey, GNHashtable customTags)
+        private OperationRequest operationRequest; // The operation request to be processed.
+        private RequestType requestType;           // The type of the request.
+        private RequestRole requestRole;           // The role associated with the request.
+        private string authToken;                  // The authentication token for the request.
+        private string secretKey;                  // The secret key for the request, if applicable.
+        private string gameId;                     // The game id for the request
+        private GNHashtable customTags;            // Custom tags to be sent with the request.
+        private Action<OperationResponse> onOperationResponse; // The callback for handling the operation response.
+        private float timeout;                     // The timeout for the operation.
+
+        private float firstSend;                   // The timestamp of the first send attempt.
+        private float secondsSend;                 // The timestamp of the response receipt.
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OperationPending"/> struct.
+        /// </summary>
+        /// <param name="requestType">The type of the request.</param>
+        /// <param name="requestRole">The role associated with the request.</param>
+        /// <param name="operationRequest">The operation request data.</param>
+        /// <param name="onOperationResponse">The callback for the response.</param>
+        /// <param name="authToken">The authentication token.</param>
+        /// <param name="secretKey">The secret key, if applicable.</param>
+        /// <param name="customTags">Custom tags for the request.</param>
+        public OperationPending(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, Action<OperationResponse> onOperationResponse, string authToken, string secretKey, GNHashtable customTags, string gameId)
         {
             this.operationRequest = operationRequest;
             this.onOperationResponse = onOperationResponse;
@@ -31,65 +45,115 @@ namespace XmobiTea.GN.Networking
             this.requestRole = requestRole;
             this.authToken = authToken;
             this.secretKey = secretKey;
+            this.gameId = gameId;
             this.customTags = customTags;
         }
 
+        /// <summary>
+        /// Gets the request type.
+        /// </summary>
+        /// <returns>The request type.</returns>
         public RequestType getRequestType()
         {
             return this.requestType;
         }
 
+        /// <summary>
+        /// Gets the request role.
+        /// </summary>
+        /// <returns>The request role.</returns>
         public RequestRole getRequestRole()
         {
             return this.requestRole;
         }
 
+        /// <summary>
+        /// Gets the authentication token for the request.
+        /// </summary>
+        /// <returns>The authentication token.</returns>
         public string getAuthToken()
         {
             return this.authToken;
         }
 
+        /// <summary>
+        /// Gets the secret key for the request.
+        /// </summary>
+        /// <returns>The secret key.</returns>
         public string getSecretKey()
         {
             return this.secretKey;
         }
 
+        /// <summary>
+        /// Gets the game id with the request.
+        /// </summary>
+        /// <returns>the game id.</returns>
+        public string getGameId()
+        {
+            return this.gameId;
+        }
+
+        /// <summary>
+        /// Gets the custom tags associated with the request.
+        /// </summary>
+        /// <returns>A GNHashtable containing the custom tags.</returns>
         public GNHashtable getCustomTags()
         {
             return this.customTags;
         }
 
+        /// <summary>
+        /// Marks the request as sent and updates the timeout.
+        /// </summary>
         public void onSend()
         {
             this.firstSend = UnityEngine.Time.realtimeSinceStartup;
             this.timeout = this.firstSend + this.operationRequest.getTimeout();
         }
 
+        /// <summary>
+        /// Marks the request as having received a response.
+        /// </summary>
         public void onRecv()
         {
             this.secondsSend = UnityEngine.Time.realtimeSinceStartup;
         }
 
+        /// <summary>
+        /// Gets the execution time of the request in milliseconds.
+        /// </summary>
+        /// <returns>The execution time in milliseconds.</returns>
         public float getExecuteTimerInMs()
         {
             return (this.secondsSend - this.firstSend) * 1000;
         }
 
+        /// <summary>
+        /// Determines whether the operation has timed out.
+        /// </summary>
+        /// <returns>True if the operation has timed out; otherwise, false.</returns>
         public bool isTimeout()
         {
             return this.timeout < UnityEngine.Time.realtimeSinceStartup;
         }
 
+        /// <summary>
+        /// Gets the operation request associated with this pending operation.
+        /// </summary>
+        /// <returns>The operation request.</returns>
         public OperationRequest getOperationRequest()
         {
             return this.operationRequest;
         }
 
+        /// <summary>
+        /// Gets the callback for handling the operation response.
+        /// </summary>
+        /// <returns>The response callback action.</returns>
         public Action<OperationResponse> getCallback()
         {
             return this.onOperationResponse;
         }
-
     }
-
 }

package/Runtime/Networking/PeerBase.cs

@@ -3,82 +3,132 @@
     using System;
     using System.Collections.Generic;
     using System.Linq;
-    using UnityEngine;
     using XmobiTea.GN.Common;
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Entity;
     using XmobiTea.GN.Logger;
 
+    /// <summary>
+    /// Abstract base class for managing common functionalities of network peers.
+    /// Implements the <see cref="IPeer"/> interface.
+    /// </summary>
     internal abstract class PeerBase : IPeer
     {
-        private Queue<OperationPending> operationPendingQueue;
+        private Queue<OperationPending> operationPendingQueue; // Queue to store pending operations to be sent.
+        private Dictionary<int, OperationPending> operationWaitingResponseDict; // Dictionary to track operations awaiting responses.
 
-        private Dictionary<int, OperationPending> operationWaitingResponseDict;
+        private static int requestId; // Static counter for generating unique request IDs.
 
-        private static int requestId;
-
-        private float perMsgTimer;
-        private float nextSendMsgTimer;
-        private float checkTimeoutOperationPending = 0;
+        private float perMsgTimer; // Interval between sending messages.
+        private float nextSendMsgTimer; // Time for the next message to be sent.
+        private float checkTimeoutOperationPending = 0; // Timer to check for timed-out operations.
 
+        /// <summary>
+        /// Gets the message send rate (messages per second).
+        /// </summary>
+        /// <returns>The send rate in messages per second.</returns>
         protected int getSendRate()
         {
             return (int)(1000 / this.perMsgTimer);
         }
 
+        /// <summary>
+        /// Sets the message send rate (messages per second).
+        /// </summary>
+        /// <param name="sendRate">The desired send rate in messages per second.</param>
         protected void setSendRate(int sendRate)
         {
             this.perMsgTimer = (float)1000 / sendRate / 1000;
         }
 
+        /// <summary>
+        /// Gets or sets the ping value for the connection.
+        /// </summary>
         internal int ping { get; set; } = -1;
-        private Queue<float> pingLst;
 
+        private Queue<float> pingLst; // Queue to store recent ping values for averaging.
+
+        /// <summary>
+        /// Gets or sets whether this peer is in use.
+        /// </summary>
         protected bool isUse { get; set; }
 
+        /// <summary>
+        /// Initializes the peer by setting up queues, dictionaries, and network objects.
+        /// </summary>
         void IPeer.initPeer()
         {
-            if (this.operationWaitingResponseDict == null) this.operationWaitingResponseDict = new Dictionary<int, OperationPending>();
+            if (this.operationWaitingResponseDict == null)
+                this.operationWaitingResponseDict = new Dictionary<int, OperationPending>();
 
-            if (this.operationPendingQueue == null) this.operationPendingQueue = new Queue<OperationPending>();
+            if (this.operationPendingQueue == null)
+                this.operationPendingQueue = new Queue<OperationPending>();
 
-            if (this.pingLst == null) this.pingLst = new Queue<float>();
+            if (this.pingLst == null)
+                this.pingLst = new Queue<float>();
 
             this.initSendRate();
             this.initGNSocketObject();
         }
 
+        /// <summary>
+        /// Initializes the message send rate based on the server settings.
+        /// </summary>
+        /// <exception cref="NullReferenceException">Thrown if server settings are not available.</exception>
         private void initSendRate()
         {
             var gnServerSettings = GNNetwork.gnServerSettings;
-            if (gnServerSettings == null) throw new NullReferenceException("Null GN Server Settings, please find it now");
+            if (gnServerSettings == null)
+                throw new NullReferenceException("Null GN Server Settings, please find it now");
 
             this.setSendRate(gnServerSettings.getSendRate());
         }
 
+        /// <summary>
+        /// Initializes the GN socket object for derived classes.
+        /// This method must be implemented in subclasses.
+        /// </summary>
         internal abstract void initGNSocketObject();
 
-        void IPeer.enqueue(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, Action<OperationResponse> onOperationResponse, string authToken, string secretKey, GNHashtable customTags)
+        /// <summary>
+        /// Enqueues an operation request for processing.
+        /// </summary>
+        /// <param name="requestType">The type of the request.</param>
+        /// <param name="requestRole">The role associated with the request.</param>
+        /// <param name="operationRequest">The operation request to be enqueued.</param>
+        /// <param name="onOperationResponse">The callback for the response.</param>
+        /// <param name="authToken">The authentication token.</param>
+        /// <param name="secretKey">The secret key, if applicable.</param>
+        /// <param name="customTags">Custom tags for the operation.</param>
+        void IPeer.enqueue(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, Action<OperationResponse> onOperationResponse, string authToken, string secretKey, GNHashtable customTags, string gameId)
         {
             if (!this.isUse)
             {
-                GNDebug.logError("[GN] Server Settings dont setup to use this to send operation request.");
+                GNDebug.logError("[GN] Server Settings don't setup to use this to send operation request.");
                 return;
             }
 
-            var operationPending = new OperationPending(requestType, requestRole, operationRequest, onOperationResponse, authToken, secretKey, customTags);
+            var operationPending = new OperationPending(requestType, requestRole, operationRequest, onOperationResponse, authToken, secretKey, customTags, gameId);
             this.operationPendingQueue.Enqueue(operationPending);
         }
 
+        /// <summary>
+        /// Checks if this peer is in use.
+        /// </summary>
+        /// <returns>True if the peer is in use, otherwise false.</returns>
         bool IPeer.isUsing()
         {
             return this.isUse;
         }
 
+        /// <summary>
+        /// Processes pending operations and handles responses and timeouts.
+        /// </summary>
         public virtual void service()
         {
             if (!this.isUse) return;
 
+            // Check for timed-out operations.
             if (this.checkTimeoutOperationPending < UnityEngine.Time.time)
             {
                 this.checkTimeoutOperationPending = UnityEngine.Time.time + 0.1f;
@@ -114,6 +164,7 @@
                 }
             }
 
+            // Send the next pending message.
             if (this.nextSendMsgTimer < UnityEngine.Time.time)
             {
                 if (this.operationPendingQueue.Count != 0)
@@ -127,6 +178,11 @@
             }
         }
 
+        /// <summary>
+        /// Handles responses from the server.
+        /// </summary>
+        /// <param name="obj">The response object.</param>
+        /// <param name="isEncrypted">Indicates if the response is encrypted.</param>
         internal void onResponseHandler(GNArray obj, bool isEncrypted)
         {
             var responseId = obj.getInt(2);
@@ -182,19 +238,15 @@
                         if (parameters.containsKey(ParameterCode.AuthToken))
                         {
                             var authToken = parameters.getString(ParameterCode.AuthToken);
-
                             GNNetwork.getAuthenticateStatus().setAuthToken(authToken);
-
-                            PlayerPrefs.SetString(GNNetwork.AUTH_TOKEN_KEY, authToken);
+                            UnityEngine.PlayerPrefs.SetString(GNNetwork.AUTH_TOKEN_KEY, authToken);
                         }
 
                         if (parameters.containsKey(ParameterCode.UserId))
                         {
                             var userId = parameters.getString(ParameterCode.UserId);
-
                             GNNetwork.getAuthenticateStatus().setUserId(userId);
-
-                            PlayerPrefs.SetString(GNNetwork.USER_ID_KEY, userId);
+                            UnityEngine.PlayerPrefs.SetString(GNNetwork.USER_ID_KEY, userId);
                         }
 
                         if (parameters.containsKey(ParameterCode.Ts))
@@ -214,6 +266,10 @@
             }
         }
 
+        /// <summary>
+        /// Sends the given operation request.
+        /// </summary>
+        /// <param name="operationPending">The operation request to be sent.</param>
         internal virtual void send(OperationPending operationPending)
         {
             operationPending.onSend();
@@ -231,12 +287,19 @@
             }
         }
 
+        /// <summary>
+        /// Adds a ping measurement for the current operation.
+        /// </summary>
+        /// <param name="value">The ping value in milliseconds.</param>
         private void addPing(float value)
         {
-            if (this.pingLst.Count > 10) this.pingLst.Dequeue();
+            if (this.pingLst.Count > 10)
+                this.pingLst.Dequeue();
+
             this.pingLst.Enqueue(value / 2);
             this.ping = (int)(this.pingLst.Average() * 1000);
         }
+
     }
 
 }

package/Runtime/Networking/Socket/NetworkingPeerSocketV2.cs

@@ -1,28 +1,42 @@
 namespace XmobiTea.GN.Networking.Socket
 {
-    using System;
+#if UNITY_USING_BEST_HTTP
 
     using BestHTTP.SocketIO;
-    using XmobiTea.GN.Entity;
+    using System;
+    using XmobiTea.GN.Common;
     using XmobiTea.GN.Constant;
-    using XmobiTea.MsgPack;
+    using XmobiTea.GN.Entity;
     using XmobiTea.GN.Logger;
-    using XmobiTea.GN.Common;
+    using XmobiTea.MsgPack;
 
+    /// <summary>
+    /// Handles socket networking using BestHTTP Socket.IO v2.
+    /// </summary>
     internal class NetworkingPeerSocketV2 : NetworkingSocketPeerBase
     {
         private SocketManager socketManager;
         private bool isConnected;
 
+        /// <summary>
+        /// Gets whether the WebSocket connection is open.
+        /// </summary>
         internal override bool isWsConnected => this.socketManager != null ? this.socketManager.State == SocketManager.States.Open : false;
 
         private SupportedSocketIOVersions serverVersion = SupportedSocketIOVersions.v3;
 
+        /// <summary>
+        /// Sets the Socket.IO server version.
+        /// </summary>
+        /// <param name="serverVersion">The server version to use.</param>
         public void setServerVersion(SupportedSocketIOVersions serverVersion)
         {
             this.serverVersion = serverVersion;
         }
 
+        /// <summary>
+        /// Sends an authentication request via the socket.
+        /// </summary>
         internal override void sendRequestAuthSocket()
         {
             base.sendRequestAuthSocket();
@@ -31,6 +45,9 @@
                 this.socketManager.Socket.Emit(Commands.RequestAuthTokenCmd, GNNetwork.getAuthenticateStatus().getAuthToken());
         }
 
+        /// <summary>
+        /// Reinitializes the socket with a new configuration.
+        /// </summary>
         internal override void reInitNewSocket()
         {
             base.reInitNewSocket();
@@ -40,7 +57,7 @@
                 var uri = new Uri(this.url + "/socket.io/");
                 this.socketManager = new SocketManager(uri, new SocketOptions()
                 {
-                    ServerVersion = serverVersion,
+                    ServerVersion = this.serverVersion,
                     Reconnection = true,
                     ReconnectionDelay = TimeSpan.FromMilliseconds(this.reconnectDelay),
                     Timeout = TimeSpan.FromMilliseconds(this.pingTimeout),
@@ -48,15 +65,15 @@
                     ConnectWith = BestHTTP.SocketIO.Transports.TransportTypes.WebSocket
                 });
 
-                this.socketManager.Socket.On(SocketIOEventTypes.Connect, onConnect);
-                this.socketManager.Socket.On(SocketIOEventTypes.Disconnect, onDisconnect);
-                this.socketManager.Socket.On(SocketIOEventTypes.Error, onError);
+                this.socketManager.Socket.On(SocketIOEventTypes.Connect, this.onConnect);
+                this.socketManager.Socket.On(SocketIOEventTypes.Disconnect, this.onDisconnect);
+                this.socketManager.Socket.On(SocketIOEventTypes.Error, this.onError);
 
-                this.socketManager.Socket.On(Commands.ResponseCmd_MsgPack, onResponseMsgPack);
-                this.socketManager.Socket.On(Commands.EventCmd_MsgPack, onEventMsgPack);
+                this.socketManager.Socket.On(Commands.ResponseCmd_MsgPack, this.onResponseMsgPack);
+                this.socketManager.Socket.On(Commands.EventCmd_MsgPack, this.onEventMsgPack);
 
-                this.socketManager.Socket.On(Commands.ResponseCmd_Json, onResponseJson);
-                this.socketManager.Socket.On(Commands.EventCmd_Json, onEventJson);
+                this.socketManager.Socket.On(Commands.ResponseCmd_Json, this.onResponseJson);
+                this.socketManager.Socket.On(Commands.EventCmd_Json, this.onEventJson);
             }
         }
 
@@ -115,18 +132,33 @@
             GNDebug.logError(string.Format("Error: {0}", args[0].ToString()));
         }
 
+        /// <summary>
+        /// Initializes the socket with the given configuration.
+        /// </summary>
+        /// <param name="url">The server URL.</param>
+        /// <param name="reconnectDelay">Delay in milliseconds before attempting to reconnect.</param>
+        /// <param name="pingInterval">Ping interval in seconds.</param>
+        /// <param name="pingTimeout">Ping timeout in seconds.</param>
         internal override void init(string url, int reconnectDelay, float pingInterval, float pingTimeout)
         {
             base.init(url, reconnectDelay, pingInterval, pingTimeout);
         }
 
-        protected override void emit(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, string authToken, string secretKey, GNHashtable customTags)
+        /// <summary>
+        /// Emits a request via the socket.
+        /// </summary>
+        /// <param name="requestType">The type of request to emit.</param>
+        /// <param name="requestRole">The role associated with the request.</param>
+        /// <param name="operationRequest">The operation request data.</param>
+        /// <param name="authToken">Authentication token, if available.</param>
+        /// <param name="secretKey">Secret key, if available.</param>
+        /// <param name="customTags">Custom tags for the request.</param>
+        protected override void emit(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, string authToken, string secretKey, GNHashtable customTags, string gameId)
         {
-            base.emit(requestType, requestRole, operationRequest, authToken, secretKey, customTags);
+            base.emit(requestType, requestRole, operationRequest, authToken, secretKey, customTags, gameId);
 
             if (this.socketManager == null || this.socketManager.Socket == null)
             {
-                // callback here
                 return;
             }
 
@@ -140,6 +172,10 @@
                 this.socketManager.Socket.Emit(Commands.RequestCmd_Json, dataSend);
         }
 
+        /// <summary>
+        /// Closes the socket connection.
+        /// </summary>
+        /// <param name="_onSocketDisconnect">Callback for when the socket is disconnected.</param>
         internal override void close(Action _onSocketDisconnect)
         {
             base.close(_onSocketDisconnect);
@@ -157,9 +193,13 @@
 
             GNDebug.log("[GN Socket] Disconnecting via SocketIOv2 BestHTTP 2");
 
-            onDisconnectHandler();
+            this.onDisconnectHandler();
         }
 
+        /// <summary>
+        /// Opens a socket connection.
+        /// </summary>
+        /// <param name="_onSocketConnect">Callback for when the socket is connected.</param>
         internal override void connect(Action _onSocketConnect)
         {
             base.connect(_onSocketConnect);
@@ -167,7 +207,6 @@
             if (this.isConnected)
             {
                 GNDebug.log("[GN Socket] Reconnecting");
-
                 return;
             }
 
@@ -177,7 +216,7 @@
 
             if (this.socketManager != null) this.socketManager.Open();
         }
-
     }
 
+#endif
 }