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

package/Runtime/Common/GNHashtable.cs

@@ -5,7 +5,7 @@
     using System.Text;
 
     /// <summary>
-    /// The GNData dictionary, it store Dictionary can be use to request or response
+    /// A hashtable implementation for GNData, supporting serialization and custom key-value storage.
     /// </summary>
     public class GNHashtable : GNData
     {
@@ -13,6 +13,12 @@
         {
             private IDictionary<string, object> dict;
 
+            /// <summary>
+            /// Adds a key-value pair to the internal dictionary.
+            /// </summary>
+            /// <param name="key">The key for the entry, must be a string.</param>
+            /// <param name="value">The value for the entry.</param>
+            /// <returns>The current Builder instance.</returns>
             public Builder add(string key, object value)
             {
                 this.dict[key] = value;
@@ -20,6 +26,11 @@
                 return this;
             }
 
+            /// <summary>
+            /// Adds all key-value pairs from an existing dictionary to the internal dictionary.
+            /// </summary>
+            /// <param name="dict">The dictionary containing key-value pairs to add.</param>
+            /// <returns>The current Builder instance.</returns>
             public Builder addAll(System.Collections.IDictionary dict)
             {
                 var keys = dict.Keys;
@@ -30,23 +41,29 @@
                         this.add(keyStr, dict[key]);
                     }
                 }
-
                 return this;
             }
 
+            /// <summary>
+            /// Constructs a new GNHashtable instance using the current key-value pairs.
+            /// </summary>
+            /// <returns>A GNHashtable containing the added key-value pairs.</returns>
             public GNHashtable build()
             {
-                var awnser = new GNHashtable();
+                var answer = new GNHashtable();
 
                 var keys = this.dict.Keys;
                 foreach (var key in keys)
                 {
-                    awnser.add(key, this.dict[key]);
+                    answer.add(key, this.dict[key]);
                 }
 
-                return awnser;
+                return answer;
             }
 
+            /// <summary>
+            /// Initializes a new instance of the Builder class.
+            /// </summary>
             public Builder()
             {
                 this.dict = new Dictionary<string, object>();
@@ -55,46 +72,97 @@
 
         private IDictionary<string, object> dict;
 
+        /// <summary>
+        /// Initializes a new instance of the GNHashtable class.
+        /// </summary>
         public GNHashtable()
         {
             this.dict = new Dictionary<string, object>();
         }
 
+        /// <summary>
+        /// Adds or updates a key-value pair in the hashtable.
+        /// </summary>
+        /// <param name="key">The key to add or update.</param>
+        /// <param name="value">The value associated with the key.</param>
         public void add(string key, object value)
         {
             this.dict[key] = GNData.createUseDataFromOriginData(value);
         }
 
+        /// <summary>
+        /// Gets or sets the value associated with the specified key.
+        /// </summary>
+        /// <param name="key">The key to get or set.</param>
+        /// <returns>The value associated with the key.</returns>
+        public object this[string key]
+        {
+            get => this.getObject(key);
+            set => this.add(key, value);
+        }
+
+        /// <summary>
+        /// Gets a collection of all values in the hashtable.
+        /// </summary>
+        /// <returns>A collection of all values in the hashtable.</returns>
         public ICollection<object> values()
         {
             return this.dict.Values;
         }
 
+        /// <summary>
+        /// Gets a collection of all keys in the hashtable.
+        /// </summary>
+        /// <returns>A collection of all keys in the hashtable.</returns>
         public ICollection<string> keys()
         {
             return this.dict.Keys;
         }
 
+        /// <summary>
+        /// Determines whether the hashtable contains the specified key.
+        /// </summary>
+        /// <param name="key">The key to locate.</param>
+        /// <returns>true if the hashtable contains the key; otherwise, false.</returns>
         public bool containsKey(string key)
         {
             return this.dict.ContainsKey(key);
         }
 
+        /// <summary>
+        /// Removes all key-value pairs from the hashtable.
+        /// </summary>
         public void clear()
         {
             this.dict.Clear();
         }
 
+        /// <summary>
+        /// Removes the value associated with the specified key.
+        /// </summary>
+        /// <param name="key">The key of the value to remove.</param>
+        /// <returns>true if the value was successfully removed; otherwise, false.</returns>
         public bool remove(string key)
         {
             return this.dict.Remove(key);
         }
 
+        /// <summary>
+        /// Gets the number of key-value pairs in the hashtable.
+        /// </summary>
+        /// <returns>The number of key-value pairs in the hashtable.</returns>
         public int count()
         {
             return this.dict.Count;
         }
 
+        /// <summary>
+        /// Retrieves the value associated with the specified key, or a default value if the key does not exist.
+        /// </summary>
+        /// <typeparam name="T">The expected type of the value.</typeparam>
+        /// <param name="k">The key to locate.</param>
+        /// <param name="defaultValue">The default value to return if the key is not found.</param>
+        /// <returns>The value associated with the key, or the default value if the key is not found.</returns>
         protected object get<T>(string k, T defaultValue = default(T))
         {
             if (this.dict.ContainsKey(k))
@@ -114,56 +182,122 @@
             return defaultValue;
         }
 
+        /// <summary>
+        /// Retrieves a byte value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The byte value associated with the key or the default value.</returns>
         public byte getByte(string k, byte defaultValue = 0)
         {
             return Convert.ToByte(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a signed byte (sbyte) value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The sbyte value associated with the key or the default value.</returns>
         public sbyte getSByte(string k, sbyte defaultValue = 0)
         {
             return Convert.ToSByte(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a short value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The short value associated with the key or the default value.</returns>
         public short getShort(string k, short defaultValue = 0)
         {
             return Convert.ToInt16(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves an integer value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The integer value associated with the key or the default value.</returns>
         public int getInt(string k, int defaultValue = 0)
         {
             return Convert.ToInt32(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a float value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The float value associated with the key or the default value.</returns>
         public float getFloat(string k, float defaultValue = 0)
         {
             return Convert.ToSingle(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a long value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The long value associated with the key or the default value.</returns>
         public long getLong(string k, long defaultValue = 0)
         {
             return Convert.ToInt64(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a double value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The double value associated with the key or the default value.</returns>
         public double getDouble(string k, double defaultValue = 0)
         {
             return Convert.ToDouble(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a boolean value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The boolean value associated with the key or the default value.</returns>
         public bool getBool(string k, bool defaultValue = false)
         {
             return Convert.ToBoolean(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a string value from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The string value associated with the key or the default value.</returns>
         public string getString(string k, string defaultValue = null)
         {
             return Convert.ToString(this.get(k, defaultValue));
         }
 
+        /// <summary>
+        /// Retrieves a raw object from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or the value cannot be converted.</param>
+        /// <returns>The object associated with the key or the default value.</returns>
         public object getObject(string k, object defaultValue = null)
         {
             return this.get(k, defaultValue);
         }
 
+        /// <summary>
+        /// Retrieves an array of type <typeparamref name="T"/> from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or cannot be converted.</param>
+        /// <returns>An array of type <typeparamref name="T"/> or the default value.</returns>
         public T[] getArray<T>(string k, T[] defaultValue = null)
         {
             var value0 = this.getGNArray(k);
@@ -175,6 +309,12 @@
             return defaultValue;
         }
 
+        /// <summary>
+        /// Retrieves a list of type <typeparamref name="T"/> from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or cannot be converted.</param>
+        /// <returns>A list of type <typeparamref name="T"/> or the default value.</returns>
         public IList<T> getList<T>(string k, IList<T> defaultValue = null)
         {
             var value0 = this.getGNArray(k);
@@ -186,16 +326,32 @@
             return defaultValue;
         }
 
+        /// <summary>
+        /// Retrieves a <see cref="GNArray"/> from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or cannot be converted.</param>
+        /// <returns>A <see cref="GNArray"/> or the default value.</returns>
         public GNArray getGNArray(string k, GNArray defaultValue = null)
         {
             return (GNArray)this.get(k, defaultValue);
         }
 
+        /// <summary>
+        /// Retrieves a <see cref="GNHashtable"/> from the hashtable for the specified key.
+        /// </summary>
+        /// <param name="k">The key to lookup in the hashtable.</param>
+        /// <param name="defaultValue">The default value to return if the key does not exist or cannot be converted.</param>
+        /// <returns>A <see cref="GNHashtable"/> or the default value.</returns>
         public GNHashtable getGNHashtable(string k, GNHashtable defaultValue = null)
         {
             return (GNHashtable)this.get(k, defaultValue);
         }
 
+        /// <summary>
+        /// Converts the hashtable to a raw data dictionary suitable for external use.
+        /// </summary>
+        /// <returns>A dictionary containing the hashtable's key-value pairs as raw data.</returns>
         public override object toData()
         {
             var answer = new Dictionary<string, object>();
@@ -208,6 +364,10 @@
             return answer;
         }
 
+        /// <summary>
+        /// Converts the hashtable to its string representation in JSON-like format.
+        /// </summary>
+        /// <returns>A string representing the hashtable.</returns>
         public override string toString()
         {
             var stringBuilder = new StringBuilder();
@@ -220,22 +380,25 @@
 
                 i++;
                 var value = c.Value;
-                if (value == null) stringBuilder.Append("\"" + c.Key.ToString() + "\"" + ":null");
-                else if (value is GNData gnData) stringBuilder.Append("\"" + c.Key.ToString() + "\"" + ":" + gnData.ToString());
-                else if (value is string valueStr) stringBuilder.Append("\"" + c.Key.ToString() + "\"" + ":" + "\"" + valueStr + "\"");
-                else if (value is bool boolValue) stringBuilder.Append("\"" + c.Key.ToString() + "\"" + ":" + boolValue.ToString().ToLower());
-                else stringBuilder.Append("\"" + c.Key.ToString() + "\"" + ":" + value);
+                if (value == null) stringBuilder.Append($"\"{c.Key}\":null");
+                else if (value is GNData gnData) stringBuilder.Append($"\"{c.Key}\":{gnData.ToString()}");
+                else if (value is string valueStr) stringBuilder.Append($"\"{c.Key}\":\"{valueStr}\"");
+                else if (value is bool boolValue) stringBuilder.Append($"\"{c.Key}\":{boolValue.ToString().ToLower()}");
+                else stringBuilder.Append($"\"{c.Key}\":{value}");
             }
 
             stringBuilder.Append("}");
             return stringBuilder.ToString();
         }
 
+        /// <summary>
+        /// Overrides the default <see cref="object.ToString"/> method to return the hashtable's string representation.
+        /// </summary>
+        /// <returns>A string representing the hashtable.</returns>
         public override string ToString()
         {
             return this.toString();
         }
-
     }
 
 }

package/Runtime/Common/IGNData.cs

@@ -1,11 +1,20 @@
 namespace XmobiTea.GN.Common
 {
+    /// <summary>
+    /// Interface defining the structure for GNData objects.
+    /// </summary>
     public interface IGNData
     {
+        /// <summary>
+        /// Converts the current GNData object into a serializable data format.
+        /// </summary>
+        /// <returns>A serializable representation of the GNData object.</returns>
         object toData();
 
+        /// <summary>
+        /// Converts the current GNData object into a string representation.
+        /// </summary>
+        /// <returns>A string representation of the GNData object.</returns>
         string toString();
-
     }
-
 }

package/Runtime/Config/GNServerSettings.cs

@@ -2,25 +2,53 @@
 {
     using UnityEngine;
 
+    /// <summary>
+    /// Enum for specifying the peer socket version.
+    /// </summary>
     public enum PeerSocketVersion
     {
+        /// <summary>
+        /// Socket.IO version 2 with protocol v2.
+        /// </summary>
         V2_v2 = 0,
+
+        /// <summary>
+        /// Socket.IO version 2 with protocol v3.
+        /// </summary>
         V2_v3 = 1,
-        V3 = 2,
 
+        /// <summary>
+        /// Socket.IO version 3.
+        /// </summary>
+        V3 = 2,
     }
 
+    /// <summary>
+    /// Enum for specifying the HTTP request type.
+    /// </summary>
     public enum HttpRequestType
     {
+        /// <summary>
+        /// UnityWebRequest for HTTP requests.
+        /// </summary>
         UnityWebRequest = 0,
 
 #if UNITY_USING_BEST_HTTP
+        /// <summary>
+        /// BestHTTP library for HTTP requests.
+        /// </summary>
         HTTPRequest = 1,
 #endif
 
+        /// <summary>
+        /// HttpWebRequest for HTTP requests.
+        /// </summary>
         HttpWebRequest = 2,
     }
 
+    /// <summary>
+    /// GN Server settings configuration.
+    /// </summary>
     //[CreateAssetMenu(fileName = GNServerSettings.ResourcesPath, menuName = "GN/GNServerSettings", order = 1)]
     public class GNServerSettings : ScriptableObject
     {
@@ -71,96 +99,112 @@
         [SerializeField]
         private GN.Logger.LogType logType = GN.Logger.LogType.All;
 
-        public string getServerAddress()
-        {
-            return this.serverAddress;
-        }
-
-        public int getServerPort()
-        {
-            return this.serverPort;
-        }
-
-        public bool isUseSsl()
-        {
-            return this.useSsl;
-        }
-
-
-        public bool isUseSocket()
-        {
-            return this.useSocket;
-        }
-
-        public bool isUseHttp()
-        {
-            return this.useHttp;
-        }
-
-        public int getSendRate()
-        {
-            return this.sendRate;
-        }
-
-        public int getReconnectDelay()
-        {
-            return this.reconnectDelay;
-        }
-
-        public float getPingInterval()
-        {
-            return this.pingInterval;
-        }
-
-        public float getPingTimeout()
-        {
-            return this.pingTimeout;
-        }
-
-        public string getAdminSecretKey()
-        {
-            return this.adminSecretKey;
-        }
-
-        public string getServerSecretKey()
-        {
-            return this.serverSecretKey;
-        }
-
-        public string getClientSecretKey()
-        {
-            return this.clientSecretKey;
-        }
-
-        public PeerSocketVersion getPeerSocketVersion()
-        {
-            return this.peerSocketVersion;
-        }
-
-        public HttpRequestType getHttpRequestType()
-        {
-            return this.httpRequestType;
-        }
-
-        public GN.Logger.LogType getLogType()
-        {
-            return this.logType;
-        }
-
-       
-        public string getSocketUrl()
-        {
-            if (this.serverPort < 0) return string.Format((this.useSsl ? "https" : "http") + "://{0}", this.serverAddress);
-            else return string.Format((this.useSsl ? "https" : "http") + "://{0}:{1}", this.serverAddress, this.serverPort);
-        }
-
-        public string getHttpUrl()
-        {
-            if (this.serverPort < 0) return string.Format((this.useSsl ? "https" : "http") + "://{0}", this.serverAddress);
-            else return string.Format((this.useSsl ? "https" : "http") + "://{0}:{1}", this.serverAddress, this.serverPort);
-        }
-
+        /// <summary>
+        /// Gets the server address.
+        /// </summary>
+        /// <returns>The server address.</returns>
+        public string getServerAddress() => this.serverAddress;
+
+        /// <summary>
+        /// Gets the server port.
+        /// </summary>
+        /// <returns>The server port.</returns>
+        public int getServerPort() => this.serverPort;
+
+        /// <summary>
+        /// Indicates whether SSL is used.
+        /// </summary>
+        /// <returns>True if SSL is used; otherwise, false.</returns>
+        public bool isUseSsl() => this.useSsl;
+
+        /// <summary>
+        /// Indicates whether socket communication is enabled.
+        /// </summary>
+        /// <returns>True if socket is used; otherwise, false.</returns>
+        public bool isUseSocket() => this.useSocket;
+
+        /// <summary>
+        /// Indicates whether HTTP communication is enabled.
+        /// </summary>
+        /// <returns>True if HTTP is used; otherwise, false.</returns>
+        public bool isUseHttp() => this.useHttp;
+
+        /// <summary>
+        /// Gets the message send rate.
+        /// </summary>
+        /// <returns>The send rate.</returns>
+        public int getSendRate() => this.sendRate;
+
+        /// <summary>
+        /// Gets the reconnect delay in milliseconds.
+        /// </summary>
+        /// <returns>The reconnect delay.</returns>
+        public int getReconnectDelay() => this.reconnectDelay;
+
+        /// <summary>
+        /// Gets the ping interval in milliseconds.
+        /// </summary>
+        /// <returns>The ping interval.</returns>
+        public float getPingInterval() => this.pingInterval;
+
+        /// <summary>
+        /// Gets the ping timeout in milliseconds.
+        /// </summary>
+        /// <returns>The ping timeout.</returns>
+        public float getPingTimeout() => this.pingTimeout;
+
+        /// <summary>
+        /// Gets the admin secret key.
+        /// </summary>
+        /// <returns>The admin secret key.</returns>
+        public string getAdminSecretKey() => this.adminSecretKey;
+
+        /// <summary>
+        /// Gets the server secret key.
+        /// </summary>
+        /// <returns>The server secret key.</returns>
+        public string getServerSecretKey() => this.serverSecretKey;
+
+        /// <summary>
+        /// Gets the client secret key.
+        /// </summary>
+        /// <returns>The client secret key.</returns>
+        public string getClientSecretKey() => this.clientSecretKey;
+
+        /// <summary>
+        /// Gets the peer socket version.
+        /// </summary>
+        /// <returns>The peer socket version.</returns>
+        public PeerSocketVersion getPeerSocketVersion() => this.peerSocketVersion;
+
+        /// <summary>
+        /// Gets the HTTP request type.
+        /// </summary>
+        /// <returns>The HTTP request type.</returns>
+        public HttpRequestType getHttpRequestType() => this.httpRequestType;
+
+        /// <summary>
+        /// Gets the log type.
+        /// </summary>
+        /// <returns>The log type.</returns>
+        public GN.Logger.LogType getLogType() => this.logType;
+
+        /// <summary>
+        /// Constructs the socket URL.
+        /// </summary>
+        /// <returns>The socket URL.</returns>
+        public string getSocketUrl() =>
+            this.serverPort < 0
+                ? $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}"
+                : $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}:{this.serverPort}";
+
+        /// <summary>
+        /// Constructs the HTTP URL.
+        /// </summary>
+        /// <returns>The HTTP URL.</returns>
+        public string getHttpUrl() =>
+            this.serverPort < 0
+                ? $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}"
+                : $"{(this.useSsl ? "https" : "http")}://{this.serverAddress}:{this.serverPort}";
     }
-
 }
-