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

package/Runtime/Entity/Request/CustomOperationRequest.cs

@@ -3,59 +3,110 @@
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Base class for creating custom operation requests.
+    /// </summary>
     public abstract class CustomOperationRequest
     {
+        /// <summary>
+        /// The operation code for the request.
+        /// </summary>
         protected abstract int operationCode { get; }
 
+        /// <summary>
+        /// Specifies if the request should be encrypted.
+        /// </summary>
         protected abstract bool operationEncrypted { get; }
 
+        /// <summary>
+        /// The type of request (e.g., Socket, HTTP).
+        /// </summary>
         protected abstract RequestType requestType { get; }
 
+        /// <summary>
+        /// The role of the request (e.g., Client, Admin, Server).
+        /// </summary>
         protected abstract RequestRole requestRole { get; }
 
+        /// <summary>
+        /// Timeout value for the operation request.
+        /// </summary>
         protected int operationTimeout { get; }
 
+        /// <summary>
+        /// Gets the request type for the operation.
+        /// </summary>
         public RequestType getRequestType()
         {
             return this.requestType;
         }
 
+        /// <summary>
+        /// Gets the request role for the operation.
+        /// </summary>
         public RequestRole getRequestRole()
         {
             return this.requestRole;
         }
 
+        /// <summary>
+        /// Constructor to initialize the operation timeout.
+        /// </summary>
+        /// <param name="timeout">Timeout in seconds for the operation.</param>
         public CustomOperationRequest(int timeout)
         {
             this.operationTimeout = timeout;
         }
 
+        /// <summary>
+        /// Builds the operation request with the provided data and settings.
+        /// </summary>
+        /// <returns>An `OperationRequest` object.</returns>
         public abstract OperationRequest build();
     }
 
+    /// <summary>
+    /// Generic base class for creating custom operation requests with strongly-typed request data.
+    /// </summary>
+    /// <typeparam name="TRequestData">The type of the request data.</typeparam>
     public abstract class CustomOperationRequest<TRequestData> : CustomOperationRequest where TRequestData : new()
     {
+        /// <summary>
+        /// Data associated with the request.
+        /// </summary>
         public TRequestData requestData { get; }
 
+        /// <summary>
+        /// Constructor to initialize with a new instance of request data and a timeout.
+        /// </summary>
+        /// <param name="timeout">Timeout in seconds for the operation.</param>
         public CustomOperationRequest(int timeout) : base(timeout)
         {
             this.requestData = new TRequestData();
         }
 
+        /// <summary>
+        /// Constructor to initialize with an existing request data object and a timeout.
+        /// </summary>
+        /// <param name="requestData">The existing request data object.</param>
+        /// <param name="timeout">Timeout in seconds for the operation.</param>
         public CustomOperationRequest(TRequestData requestData, int timeout) : base(timeout)
         {
             this.requestData = requestData;
         }
 
+        /// <summary>
+        /// Builds the operation request with serialized data and configured settings.
+        /// </summary>
+        /// <returns>An `OperationRequest` object with serialized request data.</returns>
         public override OperationRequest build()
         {
             var request = new OperationRequest(this.operationCode, this.operationEncrypted, this.operationTimeout);
 
+            // Serialize the requestData into the parameters of the request.
             request.setParameters(ConverterService.serializeObject(this.requestData));
 
             return request;
         }
-
     }
-
 }

package/Runtime/Entity/Response/CustomOperationResponse.cs

@@ -4,6 +4,9 @@
     using XmobiTea.GN.Constant;
     using XmobiTea.GN.Helper;
 
+    /// <summary>
+    /// Base class for handling custom operation responses.
+    /// </summary>
     public abstract class CustomOperationResponse
     {
         public int operationCode { get; private set; }
@@ -13,29 +16,40 @@
         public int errorCode { get; private set; }
         public InvalidMember[] invalidMembers { get; private set; }
 
+        /// <summary>
+        /// Checks if the response contains a return code indicating an error.
+        /// </summary>
         public bool hasReturnCodeError()
         {
             return this.returnCode != ReturnCode.Ok;
         }
 
+        /// <summary>
+        /// Configures the operation response using the provided `OperationResponse` object.
+        /// </summary>
+        /// <param name="operationResponse">The response from the operation to process.</param>
         public virtual void setupOperationResponse(OperationResponse operationResponse)
         {
             this.operationCode = operationResponse.getOperationCode();
             this.returnCode = operationResponse.getReturnCode();
             this.debugMessage = operationResponse.getDebugMessage();
-
             this.parameters = operationResponse.getParameters();
             this.invalidMembers = operationResponse.getInvalidMembers();
 
+            // Extract error code if the return code does not indicate an error.
             if (!this.hasReturnCodeError())
             {
                 this.errorCode = this.parameters.getInt(ParameterCode.ErrorCode);
             }
         }
 
+        /// <summary>
+        /// Returns a string representation of the response.
+        /// </summary>
         public string toString()
         {
-            return "ReturnCode: " + this.returnCode + " " + (this.parameters != null ? this.parameters.ToString() : this.debugMessage);
+            return "ReturnCode: " + this.returnCode + " " +
+                   (this.parameters != null ? this.parameters.ToString() : this.debugMessage);
         }
 
         public override string ToString()
@@ -44,20 +58,27 @@
         }
     }
 
+    /// <summary>
+    /// A generic variant of `CustomOperationResponse` that includes typed response data.
+    /// </summary>
+    /// <typeparam name="TResponseData">The type of the response data.</typeparam>
     public class CustomOperationResponse<TResponseData> : CustomOperationResponse
     {
         public TResponseData responseData { get; private set; }
 
+        /// <summary>
+        /// Configures the operation response and deserializes typed data if no errors are present.
+        /// </summary>
+        /// <param name="operationResponse">The response from the operation to process.</param>
         public override void setupOperationResponse(OperationResponse operationResponse)
         {
             base.setupOperationResponse(operationResponse);
 
             if (!this.hasReturnCodeError())
             {
+                // Deserialize the parameters into the specified response data type.
                 this.responseData = ConverterService.deserializeObject<TResponseData>(this.parameters);
             }
         }
-
     }
-
 }