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

package/Runtime/Networking/Http/NetworkingPeerUnityWebRequest.cs

@@ -3,17 +3,22 @@ namespace XmobiTea.GN.Networking.Http
     using System;
     using System.Collections;
     using System.Text;
-    using UnityEngine;
     using UnityEngine.Networking;
     using XmobiTea.GN.Common;
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Helper;
+    using XmobiTea.GN.Unity;
     using XmobiTea.MsgPack;
 
-    class UnityWebRequestSupportMono : MonoBehaviour { }
-
+    /// <summary>
+    /// Handles HTTP networking using UnityWebRequest.
+    /// </summary>
     internal class NetworkingPeerUnityWebRequest : NetworkingHttpPeerBase
     {
+        /// <summary>
+        /// A certificate handler to accept all certificates. 
+        /// Used for environments where certificates cannot be validated.
+        /// </summary>
         class AcceptAllCertificatesSignedWithASpecificKeyPublicKey : CertificateHandler
         {
             protected override bool ValidateCertificate(byte[] certificateData)
@@ -22,24 +27,51 @@ namespace XmobiTea.GN.Networking.Http
             }
         }
 
-        private MonoBehaviour unityMonoBehaviour;
-
-        public override void getRequest(string subUri, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey)
+        private UnityEngine.MonoBehaviour unityMonoBehaviour;
+
+        /// <summary>
+        /// Sends a GET request using UnityWebRequest.
+        /// </summary>
+        /// <param name="subUri">The sub-URI for the request.</param>
+        /// <param name="onHttpAppResponse">Callback to handle the HTTP response.</param>
+        /// <param name="timeout">Timeout for the request, in seconds.</param>
+        /// <param name="authToken">Optional authentication token.</param>
+        /// <param name="secretKey">Optional secret key.</param>
+        public override void getRequest(string subUri, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey, string gameId)
         {
-            this.unityMonoBehaviour.StartCoroutine(this.ieGetRequestViaUnityWebRequest(subUri, onHttpAppResponse, timeout, authToken, secretKey));
+            this.unityMonoBehaviour.StartCoroutine(this.ieGetRequestViaUnityWebRequest(subUri, onHttpAppResponse, timeout, authToken, secretKey, gameId));
         }
 
-        public override void postRequest(string subUri, GNHashtable param, PostType postType, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey, GNHashtable customTags)
+        /// <summary>
+        /// Sends a POST request with specified parameters and content type using UnityWebRequest.
+        /// </summary>
+        /// <param name="subUri">The sub-URI for the request.</param>
+        /// <param name="param">The parameters to include in the request.</param>
+        /// <param name="postType">The type of POST request (e.g., JSON, MsgPack).</param>
+        /// <param name="onHttpAppResponse">Callback to handle the HTTP response.</param>
+        /// <param name="timeout">Timeout for the request, in seconds.</param>
+        /// <param name="authToken">Optional authentication token.</param>
+        /// <param name="secretKey">Optional secret key.</param>
+        /// <param name="customTags">Optional custom tags.</param>
+        public override void postRequest(string subUri, GNHashtable param, PostType postType, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey, GNHashtable customTags, string gameId)
         {
-            this.unityMonoBehaviour.StartCoroutine(this.iePostRequestViaUnityWebRequest(subUri, param, postType, onHttpAppResponse, timeout, authToken, secretKey, customTags));
+            this.unityMonoBehaviour.StartCoroutine(this.iePostRequestViaUnityWebRequest(subUri, param, postType, onHttpAppResponse, timeout, authToken, secretKey, customTags, gameId));
         }
 
+        /// <summary>
+        /// Sends a file upload request using UnityWebRequest.
+        /// </summary>
+        /// <param name="subUri">The sub-URI for the request.</param>
+        /// <param name="content">The file content to upload.</param>
+        /// <param name="mimetype">The MIME type of the file.</param>
+        /// <param name="onHttpAppResponse">Callback to handle the HTTP response.</param>
+        /// <param name="timeout">Timeout for the request, in seconds.</param>
         public override void postRequestUpload(string subUri, byte[] content, string mimetype, Action<HttpAppResponse> onHttpAppResponse, float timeout)
         {
             this.unityMonoBehaviour.StartCoroutine(this.iePostRequestUploadViaUnityWebRequest(subUri, content, mimetype, onHttpAppResponse, timeout));
         }
 
-        private IEnumerator ieGetRequestViaUnityWebRequest(string subUri, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey)
+        private IEnumerator ieGetRequestViaUnityWebRequest(string subUri, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey, string gameId)
         {
             using (var unityWebRequest = UnityWebRequest.Get(new Uri(this.httpUrl + "/" + subUri)))
             {
@@ -50,18 +82,20 @@ namespace XmobiTea.GN.Networking.Http
 
                 if (!string.IsNullOrEmpty(authToken)) unityWebRequest.SetRequestHeader(Commands.RequestAuthTokenCmd, authToken);
                 if (!string.IsNullOrEmpty(secretKey)) unityWebRequest.SetRequestHeader(Commands.RequestSecretCmd, secretKey);
-                //unityWebRequest.SetRequestHeader("User-Agent", userAgent);
+                if (!string.IsNullOrEmpty(gameId)) unityWebRequest.SetRequestHeader(Commands.RequestGameIdCmd, gameId);
 
                 yield return unityWebRequest.SendWebRequest();
 
                 certificateHandler.Dispose();
 
-                var httpAppResponse = new HttpAppResponse();
-                httpAppResponse.statusCode = unityWebRequest.responseCode;
+                var httpAppResponse = new HttpAppResponse
+                {
+                    statusCode = unityWebRequest.responseCode
+                };
 
-                if (unityWebRequest.result == UnityWebRequest.Result.ConnectionError
-                    || unityWebRequest.result == UnityWebRequest.Result.ProtocolError
-                    || unityWebRequest.result == UnityWebRequest.Result.DataProcessingError)
+                if (unityWebRequest.result == UnityWebRequest.Result.ConnectionError ||
+                    unityWebRequest.result == UnityWebRequest.Result.ProtocolError ||
+                    unityWebRequest.result == UnityWebRequest.Result.DataProcessingError)
                 {
                     httpAppResponse.error = unityWebRequest.error;
                 }
@@ -76,7 +110,7 @@ namespace XmobiTea.GN.Networking.Http
             }
         }
 
-        private IEnumerator iePostRequestViaUnityWebRequest(string subUri, GNHashtable param, PostType postType, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey, GNHashtable customTags)
+        private IEnumerator iePostRequestViaUnityWebRequest(string subUri, GNHashtable param, PostType postType, Action<HttpAppResponse> onHttpAppResponse, float timeout, string authToken, string secretKey, GNHashtable customTags, string gameId)
         {
             using (var unityWebRequest = new UnityWebRequest(new Uri(this.httpUrl + "/" + subUri)))
             {
@@ -90,24 +124,16 @@ namespace XmobiTea.GN.Networking.Http
                 if (param == null) param = new GNHashtable();
                 if (customTags != null) param.add(GNParameterCode.CustomTags, customTags);
 
-                //unityWebRequest.SetRequestHeader("User-Agent", userAgent);
-
                 if (postType == PostType.Json)
                 {
                     unityWebRequest.SetRequestHeader(Commands.CONTENT_TYPE, Commands.APPLICATION_JSON);
-
                     var content = Encoding.UTF8.GetBytes(Serializer.Serialize(param.toData()));
-
                     unityWebRequest.uploadHandler = new UploadHandlerRaw(content);
                 }
                 else if (postType == PostType.MsgPack)
                 {
                     unityWebRequest.SetRequestHeader(Commands.CONTENT_TYPE, Commands.APPLICATION_MSGPACK);
-
-                    var dataSend = param.toData();
-
-                    var content = MsgPackSerializer.Serialize(dataSend);
-
+                    var content = MsgPackSerializer.Serialize(param.toData());
                     unityWebRequest.uploadHandler = new UploadHandlerRaw(content);
                 }
 
@@ -115,17 +141,20 @@ namespace XmobiTea.GN.Networking.Http
 
                 if (!string.IsNullOrEmpty(authToken)) unityWebRequest.SetRequestHeader(Commands.RequestAuthTokenCmd, authToken);
                 if (!string.IsNullOrEmpty(secretKey)) unityWebRequest.SetRequestHeader(Commands.RequestSecretCmd, secretKey);
+                if (!string.IsNullOrEmpty(gameId)) unityWebRequest.SetRequestHeader(Commands.RequestGameIdCmd, gameId);
 
                 yield return unityWebRequest.SendWebRequest();
 
                 certificateHandler.Dispose();
 
-                var httpAppResponse = new HttpAppResponse();
-                httpAppResponse.statusCode = unityWebRequest.responseCode;
+                var httpAppResponse = new HttpAppResponse
+                {
+                    statusCode = unityWebRequest.responseCode
+                };
 
-                if (unityWebRequest.result == UnityWebRequest.Result.ConnectionError
-                    || unityWebRequest.result == UnityWebRequest.Result.ProtocolError
-                    || unityWebRequest.result == UnityWebRequest.Result.DataProcessingError)
+                if (unityWebRequest.result == UnityWebRequest.Result.ConnectionError ||
+                    unityWebRequest.result == UnityWebRequest.Result.ProtocolError ||
+                    unityWebRequest.result == UnityWebRequest.Result.DataProcessingError)
                 {
                     httpAppResponse.error = unityWebRequest.error;
                 }
@@ -161,12 +190,14 @@ namespace XmobiTea.GN.Networking.Http
 
                 certificateHandler.Dispose();
 
-                var httpAppResponse = new HttpAppResponse();
-                httpAppResponse.statusCode = unityWebRequest.responseCode;
+                var httpAppResponse = new HttpAppResponse
+                {
+                    statusCode = unityWebRequest.responseCode
+                };
 
-                if (unityWebRequest.result == UnityWebRequest.Result.ConnectionError
-                    || unityWebRequest.result == UnityWebRequest.Result.ProtocolError
-                    || unityWebRequest.result == UnityWebRequest.Result.DataProcessingError)
+                if (unityWebRequest.result == UnityWebRequest.Result.ConnectionError ||
+                    unityWebRequest.result == UnityWebRequest.Result.ProtocolError ||
+                    unityWebRequest.result == UnityWebRequest.Result.DataProcessingError)
                 {
                     httpAppResponse.error = unityWebRequest.error;
                 }
@@ -181,12 +212,14 @@ namespace XmobiTea.GN.Networking.Http
             }
         }
 
+        /// <summary>
+        /// Constructor initializes Unity MonoBehaviour for coroutines.
+        /// </summary>
         public NetworkingPeerUnityWebRequest()
         {
-            var unityWebRequestSupport = new GameObject("[GN] UnityWebRequestSupport");
+            this.unityMonoBehaviour = new UnityEngine.GameObject("[GN] UnityWebRequestSupport").AddComponent<ServiceCoroutine>();
 
-            this.unityMonoBehaviour = unityWebRequestSupport.AddComponent<UnityWebRequestSupportMono>();
+            UnityEngine.GameObject.DontDestroyOnLoad(this.unityMonoBehaviour.gameObject);
         }
     }
-
 }

package/Runtime/Networking/IPeer.cs

@@ -5,15 +5,37 @@
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Entity;
 
+    /// <summary>
+    /// Defines the interface for managing peer communication.
+    /// </summary>
     internal interface IPeer
     {
+        /// <summary>
+        /// Initializes the peer connection.
+        /// </summary>
         void initPeer();
 
-        void enqueue(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, Action<OperationResponse> onOperationResponse, string authToken, string secretKey, GNHashtable customTags);
+        /// <summary>
+        /// Enqueues a request to be sent to the server.
+        /// </summary>
+        /// <param name="requestType">The type of request to send.</param>
+        /// <param name="requestRole">The role associated with the request.</param>
+        /// <param name="operationRequest">The operation request object containing the request data.</param>
+        /// <param name="onOperationResponse">The callback invoked upon receiving a response.</param>
+        /// <param name="authToken">The authentication token to include with the request.</param>
+        /// <param name="secretKey">The secret key to include with the request, if applicable.</param>
+        /// <param name="customTags">Custom tags to be attached to the request.</param>
+        void enqueue(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, Action<OperationResponse> onOperationResponse, string authToken, string secretKey, GNHashtable customTags, string gameId);
 
+        /// <summary>
+        /// Checks whether the peer is currently in use.
+        /// </summary>
+        /// <returns>True if the peer is in use, otherwise false.</returns>
         bool isUsing();
 
+        /// <summary>
+        /// Processes any pending requests or responses.
+        /// </summary>
         void service();
     }
-
 }

package/Runtime/Networking/NetworkingPeer.cs

@@ -5,13 +5,21 @@
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Entity;
 
+    /// <summary>
+    /// Manages networking peers for HTTP and socket communication.
+    /// </summary>
     public partial class NetworkingPeer
     {
-        private IPeer socketPeer;
-        private IPeer httpPeer;
+        private IPeer socketPeer; // Socket peer instance.
+        private IPeer httpPeer;   // HTTP peer instance.
 
-        internal AuthenticateStatus authenticateStatus;
+        internal AuthenticateStatus authenticateStatus; // Stores authentication status.
+        internal string gameId;
 
+        /// <summary>
+        /// Calculates and returns the average ping between HTTP and socket peers.
+        /// </summary>
+        /// <returns>The average ping in milliseconds.</returns>
         internal int getPing()
         {
             var count = 0;
@@ -29,28 +37,43 @@
                 totalPing += ((PeerBase)this.socketPeer).ping;
             }
 
-            return totalPing / count;
+            return count > 0 ? totalPing / count : -1;
         }
 
+        /// <summary>
+        /// Gets the client ID of the socket connection.
+        /// </summary>
+        /// <returns>The client ID as a string.</returns>
         internal string getClientId()
         {
             return (this.socketPeer as Socket.SocketPeer).getClientId();
         }
 
-        private long lastCurrentServerMilliseconds;
-        private float lastGetCurrentMilliseconds;
+        private long lastCurrentServerMilliseconds; // The last known server time in milliseconds.
+        private float lastGetCurrentMilliseconds;  // The local time in seconds when the server time was last updated.
 
+        /// <summary>
+        /// Sets the current server time in milliseconds.
+        /// </summary>
+        /// <param name="currentServerMilliseconds">The server time in milliseconds.</param>
         internal void setServerTimeMilliseconds(long currentServerMilliseconds)
         {
             this.lastCurrentServerMilliseconds = currentServerMilliseconds;
             this.lastGetCurrentMilliseconds = UnityEngine.Time.realtimeSinceStartup;
         }
 
+        /// <summary>
+        /// Gets the current server timestamp in milliseconds.
+        /// </summary>
+        /// <returns>The current server timestamp.</returns>
         internal long getServerTimestamp()
         {
             return this.lastCurrentServerMilliseconds + (int)((UnityEngine.Time.realtimeSinceStartup - this.lastGetCurrentMilliseconds) * 1000);
         }
 
+        /// <summary>
+        /// Initializes the HTTP and socket peers.
+        /// </summary>
         internal void initPeer()
         {
             this.setServerTimeMilliseconds(DateTimeOffset.UtcNow.ToUnixTimeMilliseconds());
@@ -67,12 +90,18 @@
             this.socketPeer.initPeer();
         }
 
+        /// <summary>
+        /// Processes pending operations for both HTTP and socket peers.
+        /// </summary>
         internal void service()
         {
             this.httpPeer?.service();
             this.socketPeer?.service();
         }
 
+        /// <summary>
+        /// Sends a request via socket peer.
+        /// </summary>
         internal void sendViaSocket(RequestType requestType, RequestRole requestRole, OperationRequest request, Action<OperationResponse> onResponse = null, string authToken = null, string secretKey = null, GNHashtable customTags = null)
         {
             if (authToken == null) authToken = GNNetwork.getAuthenticateStatus().getAuthToken();
@@ -83,9 +112,12 @@
                 else if (requestRole == RequestRole.Client) secretKey = GNNetwork.gnServerSettings.getClientSecretKey();
             }
 
-            this.socketPeer.enqueue(requestType, requestRole, request, onResponse, authToken, secretKey, customTags);
+            this.socketPeer.enqueue(requestType, requestRole, request, onResponse, authToken, secretKey, customTags, this.gameId);
         }
 
+        /// <summary>
+        /// Sends a request via HTTP peer.
+        /// </summary>
         internal void sendViaHttp(RequestType requestType, RequestRole requestRole, OperationRequest request, Action<OperationResponse> onResponse = null, string authToken = null, string secretKey = null, GNHashtable customTags = null)
         {
             if (authToken == null) authToken = this.authenticateStatus.getAuthToken();
@@ -96,49 +128,71 @@
                 else if (requestRole == RequestRole.Client) secretKey = GNNetwork.gnServerSettings.getClientSecretKey();
             }
 
-            this.httpPeer.enqueue(requestType, requestRole, request, onResponse, authToken, secretKey, customTags);
+            this.httpPeer.enqueue(requestType, requestRole, request, onResponse, authToken, secretKey, customTags, this.gameId);
         }
 
+        /// <summary>
+        /// Sends an authentication request via socket.
+        /// </summary>
         internal void sendRequestAuthSocket()
         {
             (this.socketPeer as Socket.SocketPeer).sendRequestAuthSocket();
         }
 
+        /// <summary>
+        /// Connects to the socket with a specified callback.
+        /// </summary>
         internal void connectSocket(Action _onSocketConnect)
         {
             (this.socketPeer as Socket.SocketPeer).connect(_onSocketConnect);
         }
 
+        /// <summary>
+        /// Disconnects the socket with a specified callback.
+        /// </summary>
         internal void disconnectSocket(Action _onSocketDisconnect)
         {
             (this.socketPeer as Socket.SocketPeer).disconnect(_onSocketDisconnect);
         }
 
+        /// <summary>
+        /// Sets the handler for processing socket events.
+        /// </summary>
         internal void setOnEventHandler(Action<OperationEvent> _onEventHandler)
         {
             (this.socketPeer as Socket.SocketPeer).setOnEventHandler(_onEventHandler);
         }
 
+        /// <summary>
+        /// Sets a handler for socket connection events.
+        /// </summary>
         internal void setOnConnectHandler(Action _onConnectHandler)
         {
             (this.socketPeer as Socket.SocketPeer).setOnConnectHandler(_onConnectHandler);
         }
 
+        /// <summary>
+        /// Sets a handler for socket disconnection events.
+        /// </summary>
         internal void setOnDisconnectHandler(Action _onDisconnectHandler)
         {
             (this.socketPeer as Socket.SocketPeer).setOnDisconnectHandler(_onDisconnectHandler);
         }
 
+        /// <summary>
+        /// Removes the handler for socket connection events.
+        /// </summary>
         internal void removeOnConnectHandler(Action _onConnectHandler)
         {
             (this.socketPeer as Socket.SocketPeer).removeOnConnectHandler(_onConnectHandler);
         }
 
+        /// <summary>
+        /// Removes the handler for socket disconnection events.
+        /// </summary>
         internal void removeOnDisconnectHandler(Action _onDisconnectHandler)
         {
             (this.socketPeer as Socket.SocketPeer).removeOnDisconnectHandler(_onDisconnectHandler);
         }
-
     }
-
 }

package/Runtime/Networking/NetworkingPeerAPI.cs

@@ -4,33 +4,44 @@
     using System.Collections;
     using XmobiTea.GN.Common;
     using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity.Response;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Provides additional functionality for managing network peers.
+    /// </summary>
     public partial class NetworkingPeer
     {
-        internal const string SYNC_TS = "ts";
-        internal const string UPLOAD_FILE = "upload";
-        internal const string DOWNLOAD_FILE = "download";
-        internal const string API_JSON = "api/" + Commands.RequestCmd_Json;
-        internal const string API_MSG_PACK = "api/" + Commands.RequestCmd_MsgPack;
-
+        internal const string SYNC_TS = "ts"; // API endpoint for synchronizing timestamps.
+        internal const string UPLOAD_FILE = "upload"; // API endpoint for file uploads.
+        internal const string DOWNLOAD_FILE = "download"; // API endpoint for file downloads.
+        internal const string API_JSON = "api/" + Commands.RequestCmd_Json; // Base path for JSON API requests.
+        internal const string API_MSG_PACK = "api/" + Commands.RequestCmd_MsgPack; // Base path for MsgPack API requests.
+
+        /// <summary>
+        /// Synchronizes the local time with the server time by retrieving the latest server timestamp.
+        /// </summary>
+        /// <param name="onResponse">An optional callback to handle the synchronized server timestamp.</param>
         internal void syncTs(Action<long> onResponse = null)
         {
+            // Sends a request to the SYNC_TS endpoint using the HTTP peer.
             (this.httpPeer as Http.HttpPeer).getRequest(NetworkingPeer.SYNC_TS, httpAppResponse =>
             {
+                // Processes the response if there is no error.
                 if (!httpAppResponse.hasError())
                 {
-                    if (httpAppResponse.statusCode == 200)
+                    if (httpAppResponse.statusCode == 200) // HTTP success status.
                     {
+                        // Parses the response text into a list and converts it to a GNArray.
                         var returnDatas = (IList)Parser.Parse(httpAppResponse.text);
                         var gnArray = new GNArray.Builder()
                             .addAll(returnDatas)
                             .build();
 
+                        // Extracts the return code and checks if the operation was successful.
                         var returnCode = gnArray.getInt(0);
                         if (returnCode == ReturnCode.Ok)
                         {
+                            // Retrieves the server timestamp from the response and updates the local timestamp.
                             var gnHashtable = gnArray.getGNHashtable(1);
                             var newServerTimestamp = gnHashtable.getLong("1", DateTimeOffset.UtcNow.ToUnixTimeMilliseconds());
 
@@ -39,21 +50,9 @@
                     }
                 }
 
+                // Invokes the callback with the current server timestamp.
                 onResponse?.Invoke(this.getServerTimestamp());
             });
         }
-
-        //internal void accountLogin(string username, string password, Action<LoginOperationResponse> onResponse = null)
-        //{
-        //    //var request = new AccountLoginOperationRequest(username, password).Build();
-
-        //    //SendViaHttp(request, response =>
-        //    //{
-        //    //    var loginOperationResponse = new LoginOperationResponse();
-        //    //    loginOperationResponse.SetupOperationResponse(response);
-
-        //    //    onResponse?.Invoke(loginOperationResponse);
-        //    //});
-        //}
     }
 }