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

package/Runtime/Entity/OperationEvent.cs

@@ -1,17 +1,24 @@
 namespace XmobiTea.GN.Entity
 {
     using System.Text;
-
     using XmobiTea.GN.Common;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents an operation event with a code, parameters, and encryption status.
+    /// </summary>
     public class OperationEvent
     {
-
         private int eventCode;
         private GNHashtable parameters;
         private bool encrypted;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OperationEvent"/> class.
+        /// </summary>
+        /// <param name="eventCode">The event code.</param>
+        /// <param name="parameters">Optional parameters associated with the event.</param>
+        /// <param name="encrypted">Whether the event is encrypted.</param>
         public OperationEvent(int eventCode, GNHashtable parameters = null, bool encrypted = true)
         {
             this.eventCode = eventCode;
@@ -19,21 +26,36 @@
             this.encrypted = encrypted;
         }
 
+        /// <summary>
+        /// Gets the event code.
+        /// </summary>
         public int getEventCode()
         {
             return this.eventCode;
         }
 
+        /// <summary>
+        /// Gets the parameters associated with the event.
+        /// </summary>
         public GNHashtable getParameters()
         {
             return this.parameters;
         }
 
+        /// <summary>
+        /// Determines if the event is encrypted.
+        /// </summary>
         public bool isEncrypted()
         {
             return this.encrypted;
         }
 
+        /// <summary>
+        /// Sets a parameter for the event.
+        /// </summary>
+        /// <param name="key">The parameter key.</param>
+        /// <param name="value">The parameter value.</param>
+        /// <returns>The updated <see cref="OperationEvent"/>.</returns>
         public OperationEvent setParameter(string key, object value)
         {
             if (this.parameters == null) this.parameters = new GNHashtable();
@@ -43,6 +65,11 @@
             return this;
         }
 
+        /// <summary>
+        /// Sets the parameters for the event.
+        /// </summary>
+        /// <param name="parameters">The parameters to set.</param>
+        /// <returns>The updated <see cref="OperationEvent"/>.</returns>
         public OperationEvent setParameters(GNHashtable parameters)
         {
             this.parameters = parameters;
@@ -50,26 +77,35 @@
             return this;
         }
 
+        /// <summary>
+        /// Sets the encryption status of the event.
+        /// </summary>
+        /// <param name="encrypted">Whether the event is encrypted.</param>
+        /// <returns>The updated <see cref="OperationEvent"/>.</returns>
         public OperationEvent setEncrypted(bool encrypted)
         {
             this.encrypted = encrypted;
             return this;
         }
 
+        /// <summary>
+        /// Converts the operation event to a string representation.
+        /// </summary>
+        /// <returns>A string describing the operation event.</returns>
         public string toString()
         {
             var stringBuilder = new StringBuilder();
-
-            stringBuilder.Append("Code: " + CodeHelper.getEventCodeName(this.eventCode) + ", parameters " + this.parameters + ", encrypted " + this.encrypted);
-
+            stringBuilder.Append("Code: " + CodeHelper.getEventCodeName(this.eventCode) + ", parameters: " + this.parameters + ", encrypted: " + this.encrypted);
             return stringBuilder.ToString();
         }
 
+        /// <summary>
+        /// Overrides the default ToString method.
+        /// </summary>
+        /// <returns>A string describing the operation event.</returns>
         public override string ToString()
         {
             return this.toString();
         }
-
     }
-
 }

package/Runtime/Entity/OperationHelper.cs

@@ -2,8 +2,18 @@ using XmobiTea.GN.Constant;
 
 namespace XmobiTea.GN.Entity
 {
+    /// <summary>
+    /// Utility class for handling operations and formatting data for socket or HTTP communication.
+    /// </summary>
     public class OperationHelper
     {
+        /// <summary>
+        /// Converts an operation request to a format suitable for socket transmission.
+        /// </summary>
+        /// <param name="requestType">The type of the request (e.g., command, query).</param>
+        /// <param name="requestRole">The role of the request (e.g., client, admin).</param>
+        /// <param name="request">The operation request to be formatted.</param>
+        /// <returns>A formatted object array ready for socket transmission.</returns>
         public static object toSocketData(RequestType requestType, RequestRole requestRole, OperationRequest request)
         {
             var requestId = request.getRequestId();
@@ -25,11 +35,17 @@ namespace XmobiTea.GN.Entity
                 };
         }
 
+        /// <summary>
+        /// Converts an operation request to a format suitable for HTTP transmission.
+        /// </summary>
+        /// <param name="requestType">The type of the request (e.g., command, query).</param>
+        /// <param name="requestRole">The role of the request (e.g., client, admin).</param>
+        /// <param name="request">The operation request to be formatted.</param>
+        /// <returns>A formatted object representing the HTTP request data.</returns>
         public static object toHttpData(RequestType requestType, RequestRole requestRole, OperationRequest request)
         {
+            // Implementation to format data for HTTP communication.
             return null;
         }
-
     }
-
 }

package/Runtime/Entity/OperationRequest.cs

@@ -1,12 +1,17 @@
 namespace XmobiTea.GN.Entity
 {
     using System.Text;
-
     using XmobiTea.GN.Common;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents an operation request, encapsulating details such as operation code, parameters, encryption, and timeout.
+    /// </summary>
     public class OperationRequest
     {
+        /// <summary>
+        /// Default timeout for operation requests in seconds.
+        /// </summary>
         public const int defaultTimeOut = 15;
 
         private int operationCode;
@@ -15,6 +20,12 @@
         private bool encrypted;
         private int timeout;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OperationRequest"/> class.
+        /// </summary>
+        /// <param name="operationCode">The code representing the operation.</param>
+        /// <param name="encrypted">Indicates whether the request is encrypted.</param>
+        /// <param name="timeout">Timeout duration for the request.</param>
         public OperationRequest(int operationCode, bool encrypted = true, int timeout = defaultTimeOut)
         {
             this.operationCode = operationCode;
@@ -22,78 +33,110 @@
             this.timeout = timeout;
         }
 
-        public int getOperationCode()
-        {
-            return this.operationCode;
-        }
-
-        public int getRequestId()
-        {
-            return this.requestId;
-        }
-
-        public GNHashtable getParameters()
-        {
-            return this.parameters;
-        }
-
-        public bool isEncrypted()
-        {
-            return this.encrypted;
-        }
-
-        public int getTimeout()
-        {
-            return this.timeout;
-        }
-
+        /// <summary>
+        /// Gets the operation code of the request.
+        /// </summary>
+        public int getOperationCode() => this.operationCode;
+
+        /// <summary>
+        /// Gets the request ID of the operation.
+        /// </summary>
+        public int getRequestId() => this.requestId;
+
+        /// <summary>
+        /// Gets the parameters associated with the operation.
+        /// </summary>
+        public GNHashtable getParameters() => this.parameters;
+
+        /// <summary>
+        /// Determines whether the request is encrypted.
+        /// </summary>
+        public bool isEncrypted() => this.encrypted;
+
+        /// <summary>
+        /// Gets the timeout duration for the request.
+        /// </summary>
+        public int getTimeout() => this.timeout;
+
+        /// <summary>
+        /// Sets the request ID for the operation.
+        /// </summary>
+        /// <param name="requestId">The request ID to set.</param>
+        /// <returns>The updated <see cref="OperationRequest"/> instance.</returns>
         public OperationRequest setRequestId(int requestId)
         {
             this.requestId = requestId;
             return this;
         }
 
+        /// <summary>
+        /// Adds or updates a parameter for the operation.
+        /// </summary>
+        /// <param name="key">The parameter key.</param>
+        /// <param name="value">The parameter value.</param>
+        /// <returns>The updated <see cref="OperationRequest"/> instance.</returns>
         public OperationRequest setParameter(string key, object value)
         {
             if (this.parameters == null) this.parameters = new GNHashtable();
-
             this.parameters.add(key, value);
-
             return this;
         }
 
+        /// <summary>
+        /// Sets the parameters for the operation.
+        /// </summary>
+        /// <param name="parameters">The parameters to set.</param>
+        /// <returns>The updated <see cref="OperationRequest"/> instance.</returns>
         public OperationRequest setParameters(GNHashtable parameters)
         {
             this.parameters = parameters;
             return this;
         }
 
+        /// <summary>
+        /// Sets whether the request is encrypted.
+        /// </summary>
+        /// <param name="encrypted">True if the request should be encrypted; otherwise false.</param>
+        /// <returns>The updated <see cref="OperationRequest"/> instance.</returns>
         public OperationRequest setEncrypted(bool encrypted)
         {
             this.encrypted = encrypted;
             return this;
         }
 
+        /// <summary>
+        /// Sets the timeout duration for the request.
+        /// </summary>
+        /// <param name="timeout">Timeout duration in seconds.</param>
+        /// <returns>The updated <see cref="OperationRequest"/> instance.</returns>
         public OperationRequest setTimeout(int timeout)
         {
             this.timeout = timeout;
             return this;
         }
 
+        /// <summary>
+        /// Converts the operation request to a string representation.
+        /// </summary>
+        /// <returns>A string representation of the operation request.</returns>
         public string toString()
         {
             var stringBuilder = new StringBuilder();
-
-            stringBuilder.Append("Code: " + CodeHelper.getOperationCodeName(this.operationCode) + ", requestId: " + this.requestId + ", parameters " + this.parameters + ", encrypted " + this.encrypted);
-
+            stringBuilder.Append("Code: ")
+                         .Append(CodeHelper.getOperationCodeName(this.operationCode))
+                         .Append(", requestId: ")
+                         .Append(this.requestId)
+                         .Append(", parameters: ")
+                         .Append(this.parameters)
+                         .Append(", encrypted: ")
+                         .Append(this.encrypted);
             return stringBuilder.ToString();
         }
 
-        public override string ToString()
-        {
-            return this.toString();
-        }
-
+        /// <summary>
+        /// Returns a string that represents the current operation request.
+        /// </summary>
+        /// <returns>A string representation of the operation request.</returns>
+        public override string ToString() => this.toString();
     }
-
 }

package/Runtime/Entity/OperationResponse.cs

@@ -1,11 +1,13 @@
 namespace XmobiTea.GN.Entity
 {
     using System.Text;
-
-    using XmobiTea.GN.Constant;
     using XmobiTea.GN.Common;
+    using XmobiTea.GN.Constant;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Represents an operation response, encapsulating details such as operation code, return code, debug messages, and parameters.
+    /// </summary>
     public class OperationResponse
     {
         private int operationCode;
@@ -17,6 +19,12 @@
 
         private InvalidMember[] invalidMembers;
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="OperationResponse"/> class.
+        /// </summary>
+        /// <param name="operationCode">The operation code associated with the response.</param>
+        /// <param name="responseId">The response ID.</param>
+        /// <param name="encrypted">Indicates whether the response is encrypted.</param>
         public OperationResponse(int operationCode, int responseId, bool encrypted = true)
         {
             this.operationCode = operationCode;
@@ -26,119 +34,159 @@
             this.debugMessage = null;
         }
 
-        public int getOperationCode()
-        {
-            return this.operationCode;
-        }
-
-        public int getReturnCode()
-        {
-            return this.returnCode;
-        }
-
-        public GNHashtable getParameters()
-        {
-            return this.parameters;
-        }
-
-        public bool isEncrypted()
-        {
-            return this.encrypted;
-        }
-
-        public int getResponseId()
-        {
-            return this.responseId;
-        }
-
-        public string getDebugMessage()
-        {
-            return this.debugMessage;
-        }
-
-        public InvalidMember[] getInvalidMembers()
-        {
-            return this.invalidMembers;
-        }
-
-        public bool hasError()
-        {
-            return this.getReturnCode() != ReturnCode.Ok;
-        }
-
+        /// <summary>
+        /// Gets the operation code of the response.
+        /// </summary>
+        public int getOperationCode() => this.operationCode;
+
+        /// <summary>
+        /// Gets the return code of the response.
+        /// </summary>
+        public int getReturnCode() => this.returnCode;
+
+        /// <summary>
+        /// Gets the parameters associated with the response.
+        /// </summary>
+        public GNHashtable getParameters() => this.parameters;
+
+        /// <summary>
+        /// Determines whether the response is encrypted.
+        /// </summary>
+        public bool isEncrypted() => this.encrypted;
+
+        /// <summary>
+        /// Gets the response ID of the operation.
+        /// </summary>
+        public int getResponseId() => this.responseId;
+
+        /// <summary>
+        /// Gets the debug message, if any.
+        /// </summary>
+        public string getDebugMessage() => this.debugMessage;
+
+        /// <summary>
+        /// Gets the invalid members, if any, associated with the response.
+        /// </summary>
+        public InvalidMember[] getInvalidMembers() => this.invalidMembers;
+
+        /// <summary>
+        /// Determines whether the response has an error based on the return code.
+        /// </summary>
+        public bool hasError() => this.getReturnCode() != ReturnCode.Ok;
+
+        /// <summary>
+        /// Sets the return code for the response.
+        /// </summary>
+        /// <param name="returnCode">The return code to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setReturnCode(int returnCode)
         {
             this.returnCode = returnCode;
             return this;
         }
 
+        /// <summary>
+        /// Sets the debug message for the response.
+        /// </summary>
+        /// <param name="debugMessage">The debug message to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setDebugMessage(string debugMessage)
         {
             this.debugMessage = debugMessage;
             return this;
         }
 
+        /// <summary>
+        /// Adds or updates a parameter for the response.
+        /// </summary>
+        /// <param name="key">The parameter key.</param>
+        /// <param name="value">The parameter value.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setParameter(string key, object value)
         {
             if (this.parameters == null) this.parameters = new GNHashtable();
-
             this.parameters.add(key, value);
-
             return this;
         }
 
+        /// <summary>
+        /// Sets the parameters for the response.
+        /// </summary>
+        /// <param name="parameters">The parameters to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setParameters(GNHashtable parameters)
         {
             this.parameters = parameters;
             return this;
         }
 
+        /// <summary>
+        /// Sets whether the response is encrypted.
+        /// </summary>
+        /// <param name="encrypted">True if the response should be encrypted; otherwise false.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setEncrypted(bool encrypted)
         {
             this.encrypted = encrypted;
             return this;
         }
 
+        /// <summary>
+        /// Sets the invalid members for the response.
+        /// </summary>
+        /// <param name="invalidMembers">The invalid members to set.</param>
+        /// <returns>The updated <see cref="OperationResponse"/> instance.</returns>
         public OperationResponse setInvalidMembers(InvalidMember[] invalidMembers)
         {
             this.invalidMembers = invalidMembers;
             return this;
         }
 
+        /// <summary>
+        /// Converts the operation response to a string representation.
+        /// </summary>
+        /// <returns>A string representation of the operation response.</returns>
         public string toString()
         {
             var stringBuilder = new StringBuilder();
 
-            stringBuilder.Append("Code: " + CodeHelper.getOperationCodeName(this.operationCode) + ", responseId: " + this.responseId + ", returnCode " + CodeHelper.getReturnCodeName(this.returnCode));
+            stringBuilder.Append("Code: ")
+                         .Append(CodeHelper.getOperationCodeName(this.operationCode))
+                         .Append(", responseId: ")
+                         .Append(this.responseId)
+                         .Append(", returnCode: ")
+                         .Append(CodeHelper.getReturnCodeName(this.returnCode));
 
-            if (this.returnCode == ReturnCode.Ok) stringBuilder.Append(", parameters " + this.parameters);
+            if (this.returnCode == ReturnCode.Ok)
+            {
+                stringBuilder.Append(", parameters: ").Append(this.parameters);
+            }
             else if (this.returnCode == ReturnCode.InvalidRequestParameters)
             {
                 if (this.invalidMembers != null)
                 {
-                    var invalidStr = string.Empty;
-
-                    foreach (var invalidMember in this.invalidMembers)
-                    {
-                        invalidStr += invalidMember;
-                    }
-
-                    stringBuilder.Append(", invalidMembers " + invalidStr);
+                    var invalidStr = string.Join(", ", this.invalidMembers);
+                    stringBuilder.Append(", invalidMembers: ").Append(invalidStr);
                 }
-                else stringBuilder.Append(", invalidMembers " + this.invalidMembers);
+                else
+                {
+                    stringBuilder.Append(", invalidMembers: null");
+                }
+            }
+            else
+            {
+                stringBuilder.Append(", debugMessage: ").Append(this.debugMessage);
             }
-            else stringBuilder.Append(", debugMessage " + this.debugMessage);
 
-            stringBuilder.Append(", encrypted " + this.encrypted);
+            stringBuilder.Append(", encrypted: ").Append(this.encrypted);
 
             return stringBuilder.ToString();
         }
 
-        public override string ToString()
-        {
-            return this.toString();
-        }
-
+        /// <summary>
+        /// Returns a string that represents the current operation response.
+        /// </summary>
+        /// <returns>A string representation of the operation response.</returns>
+        public override string ToString() => this.toString();
     }
-
 }