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

package/Runtime/Networking/Socket/NetworkingSocketPeerBase.cs

@@ -9,18 +9,42 @@ namespace XmobiTea.GN.Networking.Socket
     using XmobiTea.GN.Logger;
     using XmobiTea.MsgPack;
 
+    /// <summary>
+    /// Represents a socket packet containing data and encryption information.
+    /// </summary>
     public class SocketPacket
     {
+        /// <summary>
+        /// Gets the byte array of the packet data.
+        /// </summary>
         public byte[] byteArr { get; private set; }
+
+        /// <summary>
+        /// Indicates whether the packet is encrypted.
+        /// </summary>
         public bool encrypted { get; private set; }
+
+        /// <summary>
+        /// Gets the object data of the packet.
+        /// </summary>
         public object obj { get; private set; }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SocketPacket"/> class with byte array data.
+        /// </summary>
+        /// <param name="byteArr">The byte array of the packet.</param>
+        /// <param name="encrypted">Indicates whether the packet is encrypted.</param>
         public SocketPacket(byte[] byteArr, bool encrypted)
         {
             this.byteArr = byteArr;
             this.encrypted = encrypted;
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SocketPacket"/> class with object data.
+        /// </summary>
+        /// <param name="obj">The object data of the packet.</param>
+        /// <param name="encrypted">Indicates whether the packet is encrypted.</param>
         public SocketPacket(object obj, bool encrypted)
         {
             this.obj = obj;
@@ -28,51 +52,92 @@ namespace XmobiTea.GN.Networking.Socket
         }
     }
 
+    /// <summary>
+    /// Base class for managing socket peer connections.
+    /// </summary>
     public abstract class NetworkingSocketPeerBase
     {
         #region Public Properties
 
+        /// <summary>
+        /// The delay between reconnection attempts, in milliseconds.
+        /// </summary>
         protected internal int reconnectDelay;
+
+        /// <summary>
+        /// The interval for ping messages, in seconds.
+        /// </summary>
         protected internal float pingInterval;
+
+        /// <summary>
+        /// The timeout for ping messages, in seconds.
+        /// </summary>
         protected internal float pingTimeout;
 
+        /// <summary>
+        /// Gets or sets the client ID for the connection.
+        /// </summary>
         internal string clientId { get; set; }
+
+        /// <summary>
+        /// Gets whether the WebSocket connection is open.
+        /// </summary>
         internal virtual bool isWsConnected { get; private set; }
 
+        /// <summary>
+        /// Lock object for message lists.
+        /// </summary>
         protected internal object messageLstLock;
+
+        /// <summary>
+        /// List of response packets.
+        /// </summary>
         protected internal List<SocketPacket> responsePacketLst;
+
+        /// <summary>
+        /// List of event packets.
+        /// </summary>
         protected internal List<SocketPacket> eventPacketLst;
 
         #endregion
 
         #region Private Properties
 
+        /// <summary>
+        /// The server URL.
+        /// </summary>
         protected string url;
 
         private Action<GNArray, bool> _onEventHandler;
         private Action<GNArray, bool> _onResponseHandler;
-
         private Action _onSocketConnect;
         private Action _onSocketDisconnect;
-
         private Action _onConnectHandler;
         private Action _onDisconnectHandler;
 
         #endregion
 
+        /// <summary>
+        /// Initializes the socket peer with the specified settings.
+        /// </summary>
+        /// <param name="url">The server URL.</param>
+        /// <param name="reconnectDelay">Delay in milliseconds before reconnect attempts.</param>
+        /// <param name="pingInterval">Ping interval in seconds.</param>
+        /// <param name="pingTimeout">Ping timeout in seconds.</param>
         internal virtual void init(string url, int reconnectDelay, float pingInterval, float pingTimeout)
         {
             this.url = url;
-
             this.reconnectDelay = reconnectDelay;
             this.pingInterval = pingInterval;
             this.pingTimeout = pingTimeout;
         }
 
+        /// <summary>
+        /// Constructor for initializing the NetworkingSocketPeerBase class.
+        /// </summary>
         public NetworkingSocketPeerBase()
         {
             this.clientId = string.Empty;
-
             this.messageLstLock = new object();
             this.responsePacketLst = new List<SocketPacket>();
             this.eventPacketLst = new List<SocketPacket>();
@@ -80,59 +145,98 @@ namespace XmobiTea.GN.Networking.Socket
 
         #region Public Interface
 
+        /// <summary>
+        /// Connects to the socket server.
+        /// </summary>
+        /// <param name="_onSocketConnect">Callback invoked upon successful connection.</param>
         internal virtual void connect(Action _onSocketConnect)
         {
             this._onSocketConnect = _onSocketConnect;
         }
 
+        /// <summary>
+        /// Closes the socket connection.
+        /// </summary>
+        /// <param name="_onSocketDisconnect">Callback invoked upon disconnection.</param>
         internal virtual void close(Action _onSocketDisconnect)
         {
             this._onSocketDisconnect = _onSocketDisconnect;
         }
 
-        internal virtual void sendRequestAuthSocket()
+        /// <summary>
+        /// Sends an authentication request via the socket.
+        /// </summary>
+        internal virtual void sendRequestAuthSocket() { }
+
+        /// <summary>
+        /// Sends a request via the socket.
+        /// </summary>
+        /// <param name="requestType">The type of the request.</param>
+        /// <param name="requestRole">The role of the request.</param>
+        /// <param name="operationRequest">The operation request object.</param>
+        /// <param name="authToken">Authentication token, if applicable.</param>
+        /// <param name="secretKey">Secret key, if applicable.</param>
+        /// <param name="customTags">Custom tags for the request.</param>
+        internal void Send(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, string authToken, string secretKey, GNHashtable customTags, string gameId)
         {
-
+            this.emit(requestType, requestRole, operationRequest, authToken, secretKey, customTags, gameId);
         }
 
-        internal void Send(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, string authToken, string secretKey, GNHashtable customTags)
-        {
-            this.emit(requestType, requestRole, operationRequest, authToken, secretKey, customTags);
-        }
-
-        protected virtual void emit(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, string authToken, string secretKey, GNHashtable customTags) { }
+        /// <summary>
+        /// Emits a request to the socket.
+        /// </summary>
+        protected virtual void emit(RequestType requestType, RequestRole requestRole, OperationRequest operationRequest, string authToken, string secretKey, GNHashtable customTags, string gameId) { }
 
         #endregion
 
         #region Private Methods
 
-        internal virtual void reInitNewSocket()
-        {
-
-        }
+        /// <summary>
+        /// Reinitializes the socket connection with a new configuration.
+        /// </summary>
+        internal virtual void reInitNewSocket() { }
 
+        /// <summary>
+        /// Sets the callback to be invoked when the socket connects.
+        /// </summary>
+        /// <param name="_onConnectHandler">The callback action.</param>
         internal void setOnConnectHandler(Action _onConnectHandler)
         {
             this._onConnectHandler -= _onConnectHandler;
             this._onConnectHandler += _onConnectHandler;
         }
 
+        /// <summary>
+        /// Sets the callback to be invoked when the socket disconnects.
+        /// </summary>
+        /// <param name="_onDisconnectHandler">The callback action.</param>
         internal void setOnDisconnectHandler(Action _onDisconnectHandler)
         {
             this._onDisconnectHandler -= _onDisconnectHandler;
             this._onDisconnectHandler += _onDisconnectHandler;
         }
 
+        /// <summary>
+        /// Removes the specified callback for socket connection events.
+        /// </summary>
+        /// <param name="_onConnectHandler">The callback action to remove.</param>
         internal void removeOnConnectHandler(Action _onConnectHandler)
         {
             this._onConnectHandler -= _onConnectHandler;
         }
 
+        /// <summary>
+        /// Removes the specified callback for socket disconnection events.
+        /// </summary>
+        /// <param name="_onDisconnectHandler">The callback action to remove.</param>
         internal void removeOnDisconnectHandler(Action _onDisconnectHandler)
         {
             this._onDisconnectHandler -= _onDisconnectHandler;
         }
 
+        /// <summary>
+        /// Invokes the connection handler and sends an authentication request if applicable.
+        /// </summary>
         internal void onConnectHandler()
         {
             this._onConnectHandler?.Invoke();
@@ -147,34 +251,58 @@ namespace XmobiTea.GN.Networking.Socket
             this._onSocketConnect = null;
         }
 
+        /// <summary>
+        /// Invokes the disconnection handler and cleans up associated resources.
+        /// </summary>
         internal void onDisconnectHandler()
         {
             this._onDisconnectHandler?.Invoke();
-
             this._onSocketDisconnect?.Invoke();
             this._onSocketDisconnect = null;
         }
 
+        /// <summary>
+        /// Sets the handler for processing socket events.
+        /// </summary>
+        /// <param name="_onEventHandler">The event handler action.</param>
         internal void setOnEventHandler(Action<GNArray, bool> _onEventHandler)
         {
             this._onEventHandler = _onEventHandler;
         }
 
+        /// <summary>
+        /// Invokes the event handler with the specified data and encryption status.
+        /// </summary>
+        /// <param name="obj">The event data.</param>
+        /// <param name="isEncrypted">Indicates whether the data is encrypted.</param>
         internal void onEventHandler(GNArray obj, bool isEncrypted)
         {
             this._onEventHandler?.Invoke(obj, isEncrypted);
         }
 
+        /// <summary>
+        /// Sets the handler for processing socket responses.
+        /// </summary>
+        /// <param name="_onResponseHandler">The response handler action.</param>
         internal void setOnResponseHandler(Action<GNArray, bool> _onResponseHandler)
         {
             this._onResponseHandler = _onResponseHandler;
         }
 
+        /// <summary>
+        /// Invokes the response handler with the specified data and encryption status.
+        /// </summary>
+        /// <param name="obj">The response data.</param>
+        /// <param name="isEncrypted">Indicates whether the data is encrypted.</param>
         internal void onResponseHandler(GNArray obj, bool isEncrypted)
         {
             this._onResponseHandler?.Invoke(obj, isEncrypted);
         }
-
+        /// <summary>
+        /// Converts an array of key-value pairs to a dictionary.
+        /// </summary>
+        /// <param name="keyValuePairs">The array of key-value pairs to convert.</param>
+        /// <returns>A dictionary representing the key-value pairs.</returns>
         internal static System.Collections.IDictionary fromMsgKeyValuePairs(KeyValuePair<object, object>[] keyValuePairs)
         {
             var answer = new Dictionary<object, object>();
@@ -203,6 +331,11 @@ namespace XmobiTea.GN.Networking.Socket
             return answer;
         }
 
+        /// <summary>
+        /// Converts an array of objects to a list.
+        /// </summary>
+        /// <param name="objects">The array of objects to convert.</param>
+        /// <returns>A list representing the objects.</returns>
         internal static System.Collections.IList fromMsgList(object[] objects)
         {
             var answer = new List<object>();
@@ -228,15 +361,24 @@ namespace XmobiTea.GN.Networking.Socket
             return answer;
         }
 
+        /// <summary>
+        /// Converts a JSON object to a list.
+        /// </summary>
+        /// <param name="objects">The JSON object to convert.</param>
+        /// <returns>A list representing the JSON object.</returns>
         internal static System.Collections.IList fromJsonList(object objects)
         {
             return (System.Collections.IList)objects;
         }
 
+        /// <summary>
+        /// Processes incoming response and event packets.
+        /// </summary>
         internal void service()
         {
             lock (this.messageLstLock)
             {
+                // Process response packets
                 if (this.responsePacketLst.Count > 0)
                 {
                     for (var i = 0; i < this.responsePacketLst.Count; i++)
@@ -254,7 +396,7 @@ namespace XmobiTea.GN.Networking.Socket
                                 var gnArray = new GNArray.Builder()
                                     .addAll(NetworkingSocketPeerBase.fromMsgList(iList))
                                     .build();
-                                onResponseHandler(gnArray, responsePacket.encrypted);
+                                this.onResponseHandler(gnArray, responsePacket.encrypted);
                             }
                             catch (Exception ex)
                             {
@@ -270,7 +412,7 @@ namespace XmobiTea.GN.Networking.Socket
                                 var gnArray = new GNArray.Builder()
                                     .addAll(NetworkingSocketPeerBase.fromJsonList(iList))
                                     .build();
-                                onResponseHandler(gnArray, responsePacket.encrypted);
+                                this.onResponseHandler(gnArray, responsePacket.encrypted);
                             }
                             catch (Exception ex)
                             {
@@ -282,6 +424,7 @@ namespace XmobiTea.GN.Networking.Socket
                     this.responsePacketLst.Clear();
                 }
 
+                // Process event packets
                 if (this.eventPacketLst.Count > 0)
                 {
                     for (var i = 0; i < this.eventPacketLst.Count; i++)
@@ -299,7 +442,7 @@ namespace XmobiTea.GN.Networking.Socket
                                 var gnArray = new GNArray.Builder()
                                     .addAll(NetworkingSocketPeerBase.fromMsgList(iList))
                                     .build();
-                                onEventHandler(gnArray, eventPacket.encrypted);
+                                this.onEventHandler(gnArray, eventPacket.encrypted);
                             }
                             catch (Exception ex)
                             {
@@ -315,7 +458,7 @@ namespace XmobiTea.GN.Networking.Socket
                                 var gnArray = new GNArray.Builder()
                                     .addAll(NetworkingSocketPeerBase.fromJsonList(iList))
                                     .build();
-                                onEventHandler(gnArray, eventPacket.encrypted);
+                                this.onEventHandler(gnArray, eventPacket.encrypted);
                             }
                             catch (Exception ex)
                             {
@@ -331,5 +474,4 @@ namespace XmobiTea.GN.Networking.Socket
 
         #endregion
     }
-
 }

package/Runtime/Networking/Socket/NetworkingSocketPeerBase.cs.meta

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