Renamed DualParseLiveQueryEventArgs to ParseLiveQueryDualEventArgs

Author: theSlyest

Parse/Abstractions/Platform/LiveQueries/IParseLiveQueryController.cs

@@ -11,6 +11,18 @@ namespace Parse.Abstractions.Platform.LiveQueries;
 /// </summary>
 public interface IParseLiveQueryController
 {
+    /// <summary>
+    /// Gets or sets the timeout duration, in milliseconds, for operations performed by the LiveQuery controller.
+    /// </summary>
+    /// <remarks>
+    /// This property determines the maximum time the system will wait for an operation to complete
+    /// before timing out. It is particularly relevant to tasks such as establishing a connection
+    /// to the LiveQuery server or awaiting responses for subscription or query update requests.
+    /// Developers can use this property to configure timeouts based on the expected network
+    /// and performance conditions of the application environment.
+    /// </remarks>
+    public int TimeOut { get; set; }
+
     /// <summary>
     /// Event triggered when an error occurs during the operation of the ParseLiveQueryController.
     /// </summary>

Parse/Abstractions/Platform/LiveQueries/IParseLiveQuerySubscription.cs

@@ -24,20 +24,20 @@ public interface IParseLiveQuerySubscription
     /// This event is triggered when an object that did not previously match the query (and was thus not part of the subscription)
     /// starts matching the query, typically due to an update.
     /// </summary>
-    public event EventHandler<DualParseLiveQueryEventArgs> Enter;
+    public event EventHandler<ParseLiveQueryDualEventArgs> Enter;
 
     /// <summary>
     /// Represents the Update event for a live query subscription.
     /// This event is triggered when an existing object matching the subscription's query is updated.
     /// </summary>
-    public event EventHandler<DualParseLiveQueryEventArgs> Update;
+    public event EventHandler<ParseLiveQueryDualEventArgs> Update;
 
     /// <summary>
     /// Represents the Leave event for a live query subscription.
     /// This event is triggered when an object that previously matched the subscription's query
     /// no longer matches the criteria and is removed.
     /// </summary>
-    public event EventHandler<DualParseLiveQueryEventArgs> Leave;
+    public event EventHandler<ParseLiveQueryDualEventArgs> Leave;
 
     /// <summary>
     /// Represents the Delete event for a live query subscription.

Parse/Platform/LiveQueries/DualParseLiveQueryEventArgs.cs renamed to Parse/Platform/LiveQueries/ParseLiveQueryDualEventArgs.cs

@@ -5,23 +5,20 @@ namespace Parse.Platform.LiveQueries;
 /// This class encapsulates details about a particular event, such as the operation type,
 /// client ID, request ID, and the associated Parse object data.
 /// </summary>
-public class DualParseLiveQueryEventArgs : ParseLiveQueryEventArgs
+public class ParseLiveQueryDualEventArgs : ParseLiveQueryEventArgs
 {
-    /// <summary>
-    /// Represents the event arguments provided to Live Query event handlers in the Parse platform.
-    /// This class provides information about the current and original state of the Parse object
-    /// involved in the Live Query operation.
-    /// </summary>
-    internal DualParseLiveQueryEventArgs(ParseObject current, ParseObject original) : base(current)
-    {
-        Original = original;
-    }
-
     /// <summary>
     /// Gets the state of the Parse object before the live query event was triggered.
     /// This property represents the original data of the Parse object prior to any updates,
     /// providing a snapshot of its previous state for comparison purposes during events
     /// such as updates or deletes.
     /// </summary>
     public ParseObject Original { get; private set; }
+
+    /// <summary>
+    /// Represents the event arguments provided to Live Query event handlers in the Parse platform.
+    /// This class provides information about the current and original state of the Parse object
+    /// involved in the Live Query operation.
+    /// </summary>
+    internal ParseLiveQueryDualEventArgs(ParseObject current, ParseObject original) : base(current) => Original = original;
 }

Parse/Platform/LiveQueries/ParseLiveQueryErrorEventArgs.cs

@@ -7,16 +7,6 @@ namespace Parse.Platform.LiveQueries;
 /// </summary>
 public class ParseLiveQueryErrorEventArgs : EventArgs
 {
-    /// <summary>
-    /// Represents the arguments for an error event that occurs during a live query in the Parse platform.
-    /// </summary>
-    internal ParseLiveQueryErrorEventArgs(int code, string error, bool reconnect)
-    {
-        Error = error;
-        Code = code;
-        Reconnect = reconnect;
-    }
-
     /// <summary>
     /// Gets or sets the error message associated with a live query operation.
     /// </summary>
@@ -48,4 +38,14 @@ internal ParseLiveQueryErrorEventArgs(int code, string error, bool reconnect)
     /// connection with the server.
     /// </remarks>
     public bool Reconnect { get; private set; }
+
+    /// <summary>
+    /// Represents the arguments for an error event that occurs during a live query in the Parse platform.
+    /// </summary>
+    internal ParseLiveQueryErrorEventArgs(int code, string error, bool reconnect)
+    {
+        Error = error;
+        Code = code;
+        Reconnect = reconnect;
+    }
 }

Parse/Platform/LiveQueries/ParseLiveQueryEventArgs.cs

@@ -9,21 +9,18 @@ namespace Parse.Platform.LiveQueries;
 /// </summary>
 public class ParseLiveQueryEventArgs : EventArgs
 {
-    /// <summary>
-    /// Represents the event arguments provided to Live Query event handlers in the Parse platform.
-    /// This class provides information about the current and original state of the Parse object
-    /// involved in the Live Query operation.
-    /// </summary>
-    internal ParseLiveQueryEventArgs(ParseObject current)
-    {
-        Object = current;
-    }
-
     /// <summary>
     /// Gets the current state of the Parse object associated with the live query event.
     /// This property provides the details of the Parse object as it existed at the time
     /// the event was triggered, reflecting any changes made during operations such as
     /// an update or creation.
     /// </summary>
     public ParseObject Object { get; private set; }
+
+    /// <summary>
+    /// Represents the event arguments provided to Live Query event handlers in the Parse platform.
+    /// This class provides information about the current and original state of the Parse object
+    /// involved in the Live Query operation.
+    /// </summary>
+    internal ParseLiveQueryEventArgs(ParseObject current) => Object = current;
 }

Parse/Platform/LiveQueries/ParseLiveQuerySubscription.cs

@@ -29,20 +29,20 @@ public class ParseLiveQuerySubscription<T> : IParseLiveQuerySubscription where T
     /// This event is triggered when an object that did not previously match the query (and was thus not part of the subscription)
     /// starts matching the query, typically due to an update.
     /// </summary>
-    public event EventHandler<DualParseLiveQueryEventArgs> Enter;
+    public event EventHandler<ParseLiveQueryDualEventArgs> Enter;
 
     /// <summary>
     /// Represents the Update event for a live query subscription.
     /// This event is triggered when an existing object matching the subscription's query is updated.
     /// </summary>
-    public event EventHandler<DualParseLiveQueryEventArgs> Update;
+    public event EventHandler<ParseLiveQueryDualEventArgs> Update;
 
     /// <summary>
     /// Represents the Leave event for a live query subscription.
     /// This event is triggered when an object that previously matched the subscription's query
     /// no longer matches the criteria and is removed.
     /// </summary>
-    public event EventHandler<DualParseLiveQueryEventArgs> Leave;
+    public event EventHandler<ParseLiveQueryDualEventArgs> Leave;
 
     /// <summary>
     /// Represents the Delete event for a live query subscription.
@@ -112,7 +112,7 @@ public void OnCreate(IObjectState objectState)
     /// <param name="originalState">The original state of the object before entering the query result set.</param>
     public void OnEnter(IObjectState objectState, IObjectState originalState)
     {
-        Enter?.Invoke(this, new DualParseLiveQueryEventArgs(
+        Enter?.Invoke(this, new ParseLiveQueryDualEventArgs(
             Services.GenerateObjectFromState<T>(objectState, ClassName),
             Services.GenerateObjectFromState<T>(originalState, ClassName)));
     }
@@ -125,7 +125,7 @@ public void OnEnter(IObjectState objectState, IObjectState originalState)
     /// <param name="originalState">The original state of the object before the update.</param>
     public void OnUpdate(IObjectState objectState, IObjectState originalState)
     {
-        Update?.Invoke(this, new DualParseLiveQueryEventArgs(
+        Update?.Invoke(this, new ParseLiveQueryDualEventArgs(
             Services.GenerateObjectFromState<T>(objectState, ClassName),
             Services.GenerateObjectFromState<T>(originalState, ClassName)));
     }
@@ -139,7 +139,7 @@ public void OnUpdate(IObjectState objectState, IObjectState originalState)
     /// <param name="originalState">The original state of the object before it left the result set.</param>
     public void OnLeave(IObjectState objectState, IObjectState originalState)
     {
-        Leave?.Invoke(this, new DualParseLiveQueryEventArgs(
+        Leave?.Invoke(this, new ParseLiveQueryDualEventArgs(
             Services.GenerateObjectFromState<T>(objectState, ClassName),
             Services.GenerateObjectFromState<T>(originalState, ClassName)));
     }

Parse/Utilities/ObjectServiceExtensions.cs

@@ -92,7 +92,7 @@ public static T CreateObject<T>(this IServiceHub serviceHub) where T : ParseObje
     /// <returns>A new ParseObject for the given class name.</returns>
     public static T CreateObject<T>(this IParseObjectClassController classController, IServiceHub serviceHub) where T : ParseObject
     {
-        
+
         return (T) classController.Instantiate(classController.GetClassName(typeof(T)), serviceHub);
     }
 
@@ -289,18 +289,21 @@ public static ParseQuery<ParseObject> GetQuery(this IServiceHub serviceHub, stri
     }
 
     /// <summary>
-    /// Establishes a connection to the Live Query server using the provided <see cref="IServiceHub"/> instance.
-    /// This method ensures that the Live Query controller initiates and maintains a persistent connection.
+    /// Connects the Live Query server to the provided <see cref="IServiceHub"/> instance, enabling real-time updates for subscribed queries.
+    /// Allows error handling during the connection and sets a custom timeout period for the connection.
     /// </summary>
-    /// <param name="serviceHub">The service hub instance containing the Live Query controller to manage the connection.</param>
-    /// <returns>A task that represents the asynchronous operation of connecting to the Live Query server.</returns>
-    public static async Task ConnectLiveQueryServerAsync(this IServiceHub serviceHub, EventHandler<ParseLiveQueryErrorEventArgs> onError = null)
+    /// <param name="serviceHub">The <see cref="IServiceHub"/> instance through which the Live Query server will be connected.</param>
+    /// <param name="onError">An optional event handler to capture Live Query connection errors.</param>
+    /// <param name="timeOut">An optional timeout value, in milliseconds, for the Live Query connection. Defaults to 5000 milliseconds.</param>
+    /// <returns>A task representing the asynchronous operation of connecting to the Live Query server.</returns>
+    public static async Task ConnectLiveQueryServerAsync(this IServiceHub serviceHub, EventHandler<ParseLiveQueryErrorEventArgs> onError = null, int timeOut = 5000)
     {
         await serviceHub.LiveQueryController.ConnectAsync();
         if (onError is not null)
         {
             serviceHub.LiveQueryController.Error += onError;
         }
+        serviceHub.LiveQueryController.TimeOut = timeOut;
     }
 
     /// <summary>
@@ -363,21 +366,21 @@ internal static T GenerateObjectFromState<T>(
         {
             throw new ArgumentNullException(nameof(state), "The state cannot be null.");
         }
-        
+
         // Ensure the class name is determined or throw an exception
         string className = state.ClassName ?? defaultClassName;
         if (string.IsNullOrEmpty(className))
         {
-        
+
             throw new InvalidOperationException("Both state.ClassName and defaultClassName are null or empty. Unable to determine class name.");
         }
-        
+
         // Create the object using the class controller
         T obj = classController.Instantiate(className, serviceHub) as T;
-        
+
         if (obj == null)
         {
-        
+
             throw new InvalidOperationException($"Failed to instantiate object of type {typeof(T).Name} for class {className}.");
         }
 
@@ -464,7 +467,7 @@ static void CollectDirtyChildren(this IServiceHub serviceHub, object node, IList
     {
         CollectDirtyChildren(serviceHub, node, dirtyChildren, new HashSet<ParseObject>(new IdentityEqualityComparer<ParseObject>()), new HashSet<ParseObject>(new IdentityEqualityComparer<ParseObject>()));
     }
-    
+
     internal static async Task DeepSaveAsync(this IServiceHub serviceHub, object target, string sessionToken, CancellationToken cancellationToken)
     {
         // Collect dirty objects