Adjust event args and declaration

danielmarbach · danielmarbach · commit a0b3a030f746 · 2024-09-19T11:18:56.000+02:00
diff --git a/projects/RabbitMQ.Client/client/api/IConnection.cs b/projects/RabbitMQ.Client/client/api/IConnection.cs
@@ -161,7 +161,7 @@ public interface IConnection : INetworkConnection, IDisposable
         /// <remarks>
         /// This event will never fire for connections that disable automatic recovery.
         /// </remarks>
-        event AsyncEventHandler<EventArgs> RecoverySucceededAsync;
+        event AsyncEventHandler<AsyncEventArgs> RecoverySucceededAsync;
 
         /// <summary>
         /// Raised when the connection recovery fails, e.g. because reconnection or topology
@@ -212,7 +212,7 @@ public interface IConnection : INetworkConnection, IDisposable
         /// <summary>
         /// Raised when a connection is unblocked by the AMQP broker.
         /// </summary>
-        event AsyncEventHandler<EventArgs> ConnectionUnblockedAsync;
+        event AsyncEventHandler<AsyncEventArgs> ConnectionUnblockedAsync;
 
         /// <summary>
         /// This method updates the secret used to authenticate this connection.
diff --git a/projects/RabbitMQ.Client/client/api/IRecoverable.cs b/projects/RabbitMQ.Client/client/api/IRecoverable.cs
@@ -39,6 +39,6 @@ namespace RabbitMQ.Client
     /// </summary>
     public interface IRecoverable
     {
-        event AsyncEventHandler<EventArgs> RecoveryAsync;
+        event AsyncEventHandler<AsyncEventArgs> RecoveryAsync;
     }
 }
diff --git a/projects/RabbitMQ.Client/client/api/ShutdownEventArgs.cs b/projects/RabbitMQ.Client/client/api/ShutdownEventArgs.cs
@@ -30,6 +30,8 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
+using RabbitMQ.Client.Events;
 
 namespace RabbitMQ.Client
 {
@@ -39,7 +41,8 @@ namespace RabbitMQ.Client
     /// <remarks>
     /// The <see cref="ClassId"/> and <see cref="Initiator"/> properties should be used to determine the originator of the shutdown event.
     /// </remarks>
-    public class ShutdownEventArgs : EventArgs
+    /// TODO: Should this be moved to the events folder and the namespace be adjusted?
+    public class ShutdownEventArgs : AsyncEventArgs
     {
         private readonly Exception? _exception;
 
@@ -48,16 +51,17 @@ public class ShutdownEventArgs : EventArgs
         ///  0 for <see cref="ClassId"/> and <see cref="MethodId"/>.
         /// </summary>
         public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText,
-            object? cause = null)
-            : this(initiator, replyCode, replyText, 0, 0, cause)
+            object? cause = null, CancellationToken cancellationToken = default)
+            : this(initiator, replyCode, replyText, 0, 0, cause, cancellationToken: cancellationToken)
         {
         }
 
         /// <summary>
         /// Construct a <see cref="ShutdownEventArgs"/> with the given parameters.
         /// </summary>
         public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText,
-            ushort classId, ushort methodId, object? cause = null)
+            ushort classId, ushort methodId, object? cause = null, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             Initiator = initiator;
             ReplyCode = replyCode;
@@ -70,8 +74,8 @@ public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string r
         /// <summary>
         /// Construct a <see cref="ShutdownEventArgs"/> with the given parameters.
         /// </summary>
-        public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText, Exception exception)
-            : this(initiator, replyCode, replyText, 0, 0)
+        public ShutdownEventArgs(ShutdownInitiator initiator, ushort replyCode, string replyText, Exception exception, CancellationToken cancellationToken = default)
+            : this(initiator, replyCode, replyText, 0, 0, cancellationToken: cancellationToken)
         {
             _exception = exception ?? throw new ArgumentNullException(nameof(exception));
         }
diff --git a/projects/RabbitMQ.Client/client/events/AsyncEventArgs.cs b/projects/RabbitMQ.Client/client/events/AsyncEventArgs.cs
@@ -51,6 +51,7 @@ public class AsyncEventArgs
         /// default value is <see cref="CancellationToken.None"/>.
         /// </param>
         public AsyncEventArgs(CancellationToken cancellationToken = default)
+            : base()
         {
             CancellationToken = cancellationToken;
         }
diff --git a/projects/RabbitMQ.Client/client/events/BasicAckEventArgs.cs b/projects/RabbitMQ.Client/client/events/BasicAckEventArgs.cs
@@ -30,15 +30,16 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     ///<summary>Contains all the information about a message acknowledged
     ///from an AMQP broker within the Basic content-class.</summary>
-    public class BasicAckEventArgs : EventArgs
+    public class BasicAckEventArgs : AsyncEventArgs
     {
-        public BasicAckEventArgs(ulong deliveryTag, bool multiple)
-            : base()
+        public BasicAckEventArgs(ulong deliveryTag, bool multiple, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             DeliveryTag = deliveryTag;
             Multiple = multiple;
diff --git a/projects/RabbitMQ.Client/client/events/BasicDeliverEventArgs.cs b/projects/RabbitMQ.Client/client/events/BasicDeliverEventArgs.cs
@@ -30,12 +30,13 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     ///<summary>Contains all the information about a message delivered
     ///from an AMQP broker within the Basic content-class.</summary>
-    public class BasicDeliverEventArgs : EventArgs
+    public class BasicDeliverEventArgs : AsyncEventArgs
     {
         ///<summary>Constructor that fills the event's properties from
         ///its arguments.</summary>
@@ -45,7 +46,8 @@ public BasicDeliverEventArgs(string consumerTag,
             string exchange,
             string routingKey,
             IReadOnlyBasicProperties properties,
-            ReadOnlyMemory<byte> body) : base()
+            ReadOnlyMemory<byte> body,
+            CancellationToken cancellationToken = default) : base(cancellationToken)
         {
             ConsumerTag = consumerTag;
             DeliveryTag = deliveryTag;
diff --git a/projects/RabbitMQ.Client/client/events/BasicNackEventArgs.cs b/projects/RabbitMQ.Client/client/events/BasicNackEventArgs.cs
@@ -30,15 +30,16 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     ///<summary>Contains all the information about a message nack'd
     ///from an AMQP broker within the Basic content-class.</summary>
-    public class BasicNackEventArgs : EventArgs
+    public class BasicNackEventArgs : AsyncEventArgs
     {
-        public BasicNackEventArgs(ulong deliveryTag, bool multiple, bool requeue)
-            : base()
+        public BasicNackEventArgs(ulong deliveryTag, bool multiple, bool requeue, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             DeliveryTag = deliveryTag;
             Multiple = multiple;
diff --git a/projects/RabbitMQ.Client/client/events/BasicReturnEventArgs.cs b/projects/RabbitMQ.Client/client/events/BasicReturnEventArgs.cs
@@ -30,20 +30,22 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     ///<summary>Contains all the information about a message returned
     ///from an AMQP broker within the Basic content-class.</summary>
-    public class BasicReturnEventArgs : EventArgs
+    public class BasicReturnEventArgs : AsyncEventArgs
     {
         public BasicReturnEventArgs(
             ushort replyCode,
             string replyText,
             string exchange,
             string routingKey,
             IReadOnlyBasicProperties basicProperties,
-            ReadOnlyMemory<byte> body) : base()
+            ReadOnlyMemory<byte> body,
+            CancellationToken cancellationToken = default) : base(cancellationToken)
         {
             ReplyCode = replyCode;
             ReplyText = replyText;
diff --git a/projects/RabbitMQ.Client/client/events/CallbackExceptionEventArgs.cs b/projects/RabbitMQ.Client/client/events/CallbackExceptionEventArgs.cs
@@ -31,13 +31,15 @@
 
 using System;
 using System.Collections.Generic;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
-    public abstract class BaseExceptionEventArgs : EventArgs
+    public abstract class BaseExceptionEventArgs : AsyncEventArgs
     {
         ///<summary>Wrap an exception thrown by a callback.</summary>
-        protected BaseExceptionEventArgs(IDictionary<string, object> detail, Exception exception)
+        protected BaseExceptionEventArgs(IDictionary<string, object> detail, Exception exception, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             Detail = detail;
             Exception = exception;
@@ -76,8 +78,8 @@ public class CallbackExceptionEventArgs : BaseExceptionEventArgs
         private const string ContextString = "context";
         private const string ConsumerString = "consumer";
 
-        public CallbackExceptionEventArgs(IDictionary<string, object> detail, Exception exception)
-            : base(detail, exception)
+        public CallbackExceptionEventArgs(IDictionary<string, object> detail, Exception exception, CancellationToken cancellationToken = default)
+            : base(detail, exception, cancellationToken)
         {
         }
 
diff --git a/projects/RabbitMQ.Client/client/events/ConnectionBlockedEventArgs.cs b/projects/RabbitMQ.Client/client/events/ConnectionBlockedEventArgs.cs
@@ -30,15 +30,17 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     /// <summary>
     /// Event relating to connection being blocked.
     /// </summary>
-    public class ConnectionBlockedEventArgs : EventArgs
+    public class ConnectionBlockedEventArgs : AsyncEventArgs
     {
-        public ConnectionBlockedEventArgs(string reason)
+        public ConnectionBlockedEventArgs(string reason, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             Reason = reason;
         }
diff --git a/projects/RabbitMQ.Client/client/events/ConnectionRecoveryErrorEventArgs.cs b/projects/RabbitMQ.Client/client/events/ConnectionRecoveryErrorEventArgs.cs
@@ -30,12 +30,14 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
-    public sealed class ConnectionRecoveryErrorEventArgs : EventArgs
+    public sealed class ConnectionRecoveryErrorEventArgs : AsyncEventArgs
     {
-        public ConnectionRecoveryErrorEventArgs(Exception ex)
+        public ConnectionRecoveryErrorEventArgs(Exception ex, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             Exception = ex;
         }
diff --git a/projects/RabbitMQ.Client/client/events/ConsumerEventArgs.cs b/projects/RabbitMQ.Client/client/events/ConsumerEventArgs.cs
@@ -30,16 +30,18 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     ///<summary>Event relating to a successful consumer registration
     ///or cancellation.</summary>
-    public class ConsumerEventArgs : EventArgs
+    public class ConsumerEventArgs : AsyncEventArgs
     {
         ///<summary>Construct an event containing the consumer-tags of
         ///the consumer the event relates to.</summary>
-        public ConsumerEventArgs(string[] consumerTags)
+        public ConsumerEventArgs(string[] consumerTags, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             ConsumerTags = consumerTags;
         }
diff --git a/projects/RabbitMQ.Client/client/events/ConsumerTagChangedAfterRecoveryEventArgs.cs b/projects/RabbitMQ.Client/client/events/ConsumerTagChangedAfterRecoveryEventArgs.cs
@@ -30,17 +30,20 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
-    public sealed class ConsumerTagChangedAfterRecoveryEventArgs : EventArgs
+    public sealed class ConsumerTagChangedAfterRecoveryEventArgs : AsyncEventArgs
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="ConsumerTagChangedAfterRecoveryEventArgs"/> class.
         /// </summary>
         /// <param name="tagBefore">The tag before.</param>
         /// <param name="tagAfter">The tag after.</param>
-        public ConsumerTagChangedAfterRecoveryEventArgs(string tagBefore, string tagAfter)
+        /// <param name="cancellationToken">The cancellation token.</param>
+        public ConsumerTagChangedAfterRecoveryEventArgs(string tagBefore, string tagAfter, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             TagBefore = tagBefore;
             TagAfter = tagAfter;
diff --git a/projects/RabbitMQ.Client/client/events/FlowControlEventArgs.cs b/projects/RabbitMQ.Client/client/events/FlowControlEventArgs.cs
@@ -30,15 +30,17 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     /// <summary>
     /// Event relating to flow control.
     /// </summary>
-    public class FlowControlEventArgs : EventArgs
+    public class FlowControlEventArgs : AsyncEventArgs
     {
-        public FlowControlEventArgs(bool active)
+        public FlowControlEventArgs(bool active, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             Active = active;
         }
diff --git a/projects/RabbitMQ.Client/client/events/QueueNameChangedAfterRecoveryEventArgs.cs b/projects/RabbitMQ.Client/client/events/QueueNameChangedAfterRecoveryEventArgs.cs
@@ -30,17 +30,20 @@
 //---------------------------------------------------------------------------
 
 using System;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
-    public sealed class QueueNameChangedAfterRecoveryEventArgs : EventArgs
+    public sealed class QueueNameChangedAfterRecoveryEventArgs : AsyncEventArgs
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="QueueNameChangedAfterRecoveryEventArgs"/> class.
         /// </summary>
         /// <param name="nameBefore">The name before.</param>
         /// <param name="nameAfter">The name after.</param>
-        public QueueNameChangedAfterRecoveryEventArgs(string nameBefore, string nameAfter)
+        /// <param name="cancellationToken">The cancellation token.</param>
+        public QueueNameChangedAfterRecoveryEventArgs(string nameBefore, string nameAfter, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             NameBefore = nameBefore;
             NameAfter = nameAfter;
diff --git a/projects/RabbitMQ.Client/client/events/RecoveringConsumerEventArgs.cs b/projects/RabbitMQ.Client/client/events/RecoveringConsumerEventArgs.cs
@@ -30,21 +30,24 @@
 //---------------------------------------------------------------------------
 
 using System.Collections.Generic;
+using System.Threading;
 
 namespace RabbitMQ.Client.Events
 {
     /// <summary>
     /// Event related to consumer recovery, during automatic recovery.
     /// </summary>
-    public class RecoveringConsumerEventArgs
+    public class RecoveringConsumerEventArgs : AsyncEventArgs
     {
         /// <summary>
         /// Constructs an event containing the consumer arguments and consumer
         /// tag of the consumer this event relates to.
         /// </summary>
         /// <param name="consumerTag">Consumer arguments of the consumer for this event</param>
         /// <param name="consumerArguments">Consumer tag of the consumer for this event</param>
-        public RecoveringConsumerEventArgs(string consumerTag, IDictionary<string, object?>? consumerArguments)
+        /// <param name="cancellationToken">The cancellation token.</param>
+        public RecoveringConsumerEventArgs(string consumerTag, IDictionary<string, object?>? consumerArguments, CancellationToken cancellationToken = default)
+            : base(cancellationToken)
         {
             ConsumerTag = consumerTag;
             ConsumerArguments = consumerArguments;
diff --git a/projects/RabbitMQ.Client/client/impl/AsyncEventingWrapper.cs b/projects/RabbitMQ.Client/client/impl/AsyncEventingWrapper.cs
@@ -4,7 +4,7 @@
 
 namespace RabbitMQ.Client.Impl
 {
-    internal struct AsyncEventingWrapper<T>
+    internal struct AsyncEventingWrapper<T> where T : AsyncEventArgs
     {
         private event AsyncEventHandler<T>? _event;
         private Delegate[]? _handlers;
diff --git a/projects/RabbitMQ.Client/client/impl/AutorecoveringChannel.cs b/projects/RabbitMQ.Client/client/impl/AutorecoveringChannel.cs
@@ -115,7 +115,7 @@ public event AsyncEventHandler<ShutdownEventArgs> ChannelShutdownAsync
             remove => InnerChannel.ChannelShutdownAsync -= value;
         }
 
-        public event AsyncEventHandler<EventArgs> RecoveryAsync
+        public event AsyncEventHandler<AsyncEventArgs> RecoveryAsync
         {
             add { InnerChannel.RecoveryAsync += value; }
             remove { InnerChannel.RecoveryAsync -= value; }
diff --git a/projects/RabbitMQ.Client/client/impl/AutorecoveringConnection.Recovery.cs b/projects/RabbitMQ.Client/client/impl/AutorecoveringConnection.Recovery.cs
@@ -206,7 +206,7 @@ await RecoverChannelsAndItsConsumersAsync(recordedEntitiesSemaphoreHeld: true, c
 
                     ESLog.Info("Connection recovery completed");
                     ThrowIfDisposed();
-                    await _recoverySucceededAsyncWrapper.InvokeAsync(this, EventArgs.Empty)
+                    await _recoverySucceededAsyncWrapper.InvokeAsync(this, AsyncEventArgs.Empty)
                         .ConfigureAwait(false);
 
                     return true;
diff --git a/projects/RabbitMQ.Client/client/impl/AutorecoveringConnection.cs b/projects/RabbitMQ.Client/client/impl/AutorecoveringConnection.cs
diff --git a/projects/RabbitMQ.Client/client/impl/ChannelBase.cs b/projects/RabbitMQ.Client/client/impl/ChannelBase.cs
diff --git a/projects/RabbitMQ.Client/client/impl/Connection.Commands.cs b/projects/RabbitMQ.Client/client/impl/Connection.Commands.cs
diff --git a/projects/RabbitMQ.Client/client/impl/Connection.cs b/projects/RabbitMQ.Client/client/impl/Connection.cs

Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,6 @@ namespace RabbitMQ.Client`
`39`	`39`	`/// </summary>`
`40`	`40`	`public interface IRecoverable`
`41`	`41`	`{`
`42`		`- event AsyncEventHandler<EventArgs> RecoveryAsync;`
	`42`	`+ event AsyncEventHandler<AsyncEventArgs> RecoveryAsync;`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ public class AsyncEventArgs`
`51`	`51`	`/// default value is <see cref="CancellationToken.None"/>.`
`52`	`52`	`/// </param>`
`53`	`53`	`public AsyncEventArgs(CancellationToken cancellationToken = default)`
	`54`	`+ : base()`
`54`	`55`	`{`
`55`	`56`	`CancellationToken = cancellationToken;`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,15 +30,16 @@`
`30`	`30`	`//---------------------------------------------------------------------------`
`31`	`31`
`32`	`32`	`using System;`
	`33`	`+using System.Threading;`
`33`	`34`
`34`	`35`	`namespace RabbitMQ.Client.Events`
`35`	`36`	`{`
`36`	`37`	`///<summary>Contains all the information about a message acknowledged`
`37`	`38`	`///from an AMQP broker within the Basic content-class.</summary>`
`38`		`- public class BasicAckEventArgs : EventArgs`
	`39`	`+ public class BasicAckEventArgs : AsyncEventArgs`
`39`	`40`	`{`
`40`		`- public BasicAckEventArgs(ulong deliveryTag, bool multiple)`
`41`		`- : base()`
	`41`	`+ public BasicAckEventArgs(ulong deliveryTag, bool multiple, CancellationToken cancellationToken = default)`
	`42`	`+ : base(cancellationToken)`
`42`	`43`	`{`
`43`	`44`	`DeliveryTag = deliveryTag;`
`44`	`45`	`Multiple = multiple;`
Original file line number	Diff line number	Diff line change
`@@ -31,13 +31,15 @@`
`31`	`31`
`32`	`32`	`using System;`
`33`	`33`	`using System.Collections.Generic;`
	`34`	`+using System.Threading;`
`34`	`35`
`35`	`36`	`namespace RabbitMQ.Client.Events`
`36`	`37`	`{`
`37`		`- public abstract class BaseExceptionEventArgs : EventArgs`
	`38`	`+ public abstract class BaseExceptionEventArgs : AsyncEventArgs`
`38`	`39`	`{`
`39`	`40`	`///<summary>Wrap an exception thrown by a callback.</summary>`
`40`		`- protected BaseExceptionEventArgs(IDictionary<string, object> detail, Exception exception)`
	`41`	`+ protected BaseExceptionEventArgs(IDictionary<string, object> detail, Exception exception, CancellationToken cancellationToken = default)`
	`42`	`+ : base(cancellationToken)`
`41`	`43`	`{`
`42`	`44`	`Detail = detail;`
`43`	`45`	`Exception = exception;`
`@@ -76,8 +78,8 @@ public class CallbackExceptionEventArgs : BaseExceptionEventArgs`
`76`	`78`	`private const string ContextString = "context";`
`77`	`79`	`private const string ConsumerString = "consumer";`
`78`	`80`
`79`		`- public CallbackExceptionEventArgs(IDictionary<string, object> detail, Exception exception)`
`80`		`- : base(detail, exception)`
	`81`	`+ public CallbackExceptionEventArgs(IDictionary<string, object> detail, Exception exception, CancellationToken cancellationToken = default)`
	`82`	`+ : base(detail, exception, cancellationToken)`
`81`	`83`	`{`
`82`	`84`	`}`
`83`	`85`
Original file line number	Diff line number	Diff line change
`@@ -30,15 +30,17 @@`
`30`	`30`	`//---------------------------------------------------------------------------`
`31`	`31`
`32`	`32`	`using System;`
	`33`	`+using System.Threading;`
`33`	`34`
`34`	`35`	`namespace RabbitMQ.Client.Events`
`35`	`36`	`{`
`36`	`37`	`/// <summary>`
`37`	`38`	`/// Event relating to connection being blocked.`
`38`	`39`	`/// </summary>`
`39`		`- public class ConnectionBlockedEventArgs : EventArgs`
	`40`	`+ public class ConnectionBlockedEventArgs : AsyncEventArgs`
`40`	`41`	`{`
`41`		`- public ConnectionBlockedEventArgs(string reason)`
	`42`	`+ public ConnectionBlockedEventArgs(string reason, CancellationToken cancellationToken = default)`
	`43`	`+ : base(cancellationToken)`
`42`	`44`	`{`
`43`	`45`	`Reason = reason;`
`44`	`46`	`}`