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

package/Runtime/Networking/NetworkingPeer.cs

@@ -1,144 +1,198 @@
-namespace XmobiTea.GN.Networking
-{
-    using System;
-    using XmobiTea.GN.Common;
-    using XmobiTea.GN.Constant;
-    using XmobiTea.GN.Entity;
-
-    public partial class NetworkingPeer
-    {
-        private IPeer socketPeer;
-        private IPeer httpPeer;
-
-        internal AuthenticateStatus authenticateStatus;
-
-        internal int getPing()
-        {
-            var count = 0;
-            var totalPing = 0;
-
-            if (this.httpPeer.isUsing())
-            {
-                count++;
-                totalPing += ((PeerBase)this.httpPeer).ping;
-            }
-
-            if (this.socketPeer.isUsing())
-            {
-                count++;
-                totalPing += ((PeerBase)this.socketPeer).ping;
-            }
-
-            return totalPing / count;
-        }
-
-        internal string getClientId()
-        {
-            return (this.socketPeer as Socket.SocketPeer).getClientId();
-        }
-
-        private long lastCurrentServerMilliseconds;
-        private float lastGetCurrentMilliseconds;
-
-        internal void setServerTimeMilliseconds(long currentServerMilliseconds)
-        {
-            this.lastCurrentServerMilliseconds = currentServerMilliseconds;
-            this.lastGetCurrentMilliseconds = UnityEngine.Time.realtimeSinceStartup;
-        }
-
-        internal long getServerTimestamp()
-        {
-            return this.lastCurrentServerMilliseconds + (int)((UnityEngine.Time.realtimeSinceStartup - this.lastGetCurrentMilliseconds) * 1000);
-        }
-
-        internal void initPeer()
-        {
-            this.setServerTimeMilliseconds(DateTimeOffset.UtcNow.ToUnixTimeMilliseconds());
-
-            var gnServerSettings = GNNetwork.gnServerSettings;
-            if (gnServerSettings == null) throw new NullReferenceException("Null GN Server Settings, please find it now");
-
-            this.authenticateStatus = new AuthenticateStatus();
-
-            this.httpPeer = new Http.HttpPeer();
-            this.httpPeer.initPeer();
-
-            this.socketPeer = new Socket.SocketPeer();
-            this.socketPeer.initPeer();
-        }
-
-        internal void service()
-        {
-            this.httpPeer?.service();
-            this.socketPeer?.service();
-        }
-
-        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();
-            if (secretKey == null)
-            {
-                if (requestRole == RequestRole.Admin) secretKey = GNNetwork.gnServerSettings.getAdminSecretKey();
-                else if (requestRole == RequestRole.Server) secretKey = GNNetwork.gnServerSettings.getServerSecretKey();
-                else if (requestRole == RequestRole.Client) secretKey = GNNetwork.gnServerSettings.getClientSecretKey();
-            }
-
-            this.socketPeer.enqueue(requestType, requestRole, request, onResponse, authToken, secretKey, customTags);
-        }
-
-        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();
-            if (secretKey == null)
-            {
-                if (requestRole == RequestRole.Admin) secretKey = GNNetwork.gnServerSettings.getAdminSecretKey();
-                else if (requestRole == RequestRole.Server) secretKey = GNNetwork.gnServerSettings.getServerSecretKey();
-                else if (requestRole == RequestRole.Client) secretKey = GNNetwork.gnServerSettings.getClientSecretKey();
-            }
-
-            this.httpPeer.enqueue(requestType, requestRole, request, onResponse, authToken, secretKey, customTags);
-        }
-
-        internal void sendRequestAuthSocket()
-        {
-            (this.socketPeer as Socket.SocketPeer).sendRequestAuthSocket();
-        }
-
-        internal void connectSocket(Action _onSocketConnect)
-        {
-            (this.socketPeer as Socket.SocketPeer).connect(_onSocketConnect);
-        }
-
-        internal void disconnectSocket(Action _onSocketDisconnect)
-        {
-            (this.socketPeer as Socket.SocketPeer).disconnect(_onSocketDisconnect);
-        }
-
-        internal void setOnEventHandler(Action<OperationEvent> _onEventHandler)
-        {
-            (this.socketPeer as Socket.SocketPeer).setOnEventHandler(_onEventHandler);
-        }
-
-        internal void setOnConnectHandler(Action _onConnectHandler)
-        {
-            (this.socketPeer as Socket.SocketPeer).setOnConnectHandler(_onConnectHandler);
-        }
-
-        internal void setOnDisconnectHandler(Action _onDisconnectHandler)
-        {
-            (this.socketPeer as Socket.SocketPeer).setOnDisconnectHandler(_onDisconnectHandler);
-        }
-
-        internal void removeOnConnectHandler(Action _onConnectHandler)
-        {
-            (this.socketPeer as Socket.SocketPeer).removeOnConnectHandler(_onConnectHandler);
-        }
-
-        internal void removeOnDisconnectHandler(Action _onDisconnectHandler)
-        {
-            (this.socketPeer as Socket.SocketPeer).removeOnDisconnectHandler(_onDisconnectHandler);
-        }
-
-    }
-
-}
+namespace XmobiTea.GN.Networking
+{
+    using System;
+    using XmobiTea.GN.Common;
+    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; // Socket peer instance.
+        private IPeer httpPeer;   // HTTP peer instance.
+
+        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;
+            var totalPing = 0;
+
+            if (this.httpPeer.isUsing())
+            {
+                count++;
+                totalPing += ((PeerBase)this.httpPeer).ping;
+            }
+
+            if (this.socketPeer.isUsing())
+            {
+                count++;
+                totalPing += ((PeerBase)this.socketPeer).ping;
+            }
+
+            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; // 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());
+
+            var gnServerSettings = GNNetwork.gnServerSettings;
+            if (gnServerSettings == null) throw new NullReferenceException("Null GN Server Settings, please find it now");
+
+            this.authenticateStatus = new AuthenticateStatus();
+
+            this.httpPeer = new Http.HttpPeer();
+            this.httpPeer.initPeer();
+
+            this.socketPeer = new Socket.SocketPeer();
+            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();
+            if (secretKey == null)
+            {
+                if (requestRole == RequestRole.Admin) secretKey = GNNetwork.gnServerSettings.getAdminSecretKey();
+                else if (requestRole == RequestRole.Server) secretKey = GNNetwork.gnServerSettings.getServerSecretKey();
+                else if (requestRole == RequestRole.Client) secretKey = GNNetwork.gnServerSettings.getClientSecretKey();
+            }
+
+            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();
+            if (secretKey == null)
+            {
+                if (requestRole == RequestRole.Admin) secretKey = GNNetwork.gnServerSettings.getAdminSecretKey();
+                else if (requestRole == RequestRole.Server) secretKey = GNNetwork.gnServerSettings.getServerSecretKey();
+                else if (requestRole == RequestRole.Client) secretKey = GNNetwork.gnServerSettings.getClientSecretKey();
+            }
+
+            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/NetworkingPeer.cs.meta

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

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);
-        //    //});
-        //}
     }
 }

package/Runtime/Networking/NetworkingPeerAPI.cs.meta

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