Skip to content

Ensure Connection and Channel cancellation token properly float into handlers #1740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2025
+415 −101
Merged

Ensure Connection and Channel cancellation token properly float into handlers #1740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions projects/RabbitMQ.Client/ConsumerDispatching/AsyncConsumerDispatcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,20 @@ protected override async Task ProcessChannelAsync()
{
await work.Consumer.HandleBasicDeliverAsync(
work.ConsumerTag!, work.DeliveryTag, work.Redelivered,
work.Exchange!, work.RoutingKey!, work.BasicProperties!, work.Body.Memory)
work.Exchange!, work.RoutingKey!, work.BasicProperties!, work.Body.Memory, work.CancellationToken)
.ConfigureAwait(false);
}
break;
case WorkType.Cancel:
await work.Consumer.HandleBasicCancelAsync(work.ConsumerTag!)
await work.Consumer.HandleBasicCancelAsync(work.ConsumerTag!, work.CancellationToken)
.ConfigureAwait(false);
break;
case WorkType.CancelOk:
await work.Consumer.HandleBasicCancelOkAsync(work.ConsumerTag!)
await work.Consumer.HandleBasicCancelOkAsync(work.ConsumerTag!, work.CancellationToken)
.ConfigureAwait(false);
break;
case WorkType.ConsumeOk:
await work.Consumer.HandleBasicConsumeOkAsync(work.ConsumerTag!)
await work.Consumer.HandleBasicConsumeOkAsync(work.ConsumerTag!, work.CancellationToken)
.ConfigureAwait(false);
break;
case WorkType.Shutdown:
Expand Down
98 changes: 70 additions & 28 deletions projects/RabbitMQ.Client/ConsumerDispatching/ConsumerDispatcherChannelBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ internal abstract class ConsumerDispatcherChannelBase : ConsumerDispatcherBase,
private readonly ushort _concurrency;
private long _isQuiescing;
private bool _disposed;
private readonly CancellationTokenSource _shutdownCts = new CancellationTokenSource();

internal ConsumerDispatcherChannelBase(Impl.Channel channel, ushort concurrency)
{
Expand Down Expand Up @@ -92,7 +93,7 @@ public async ValueTask HandleBasicConsumeOkAsync(IAsyncBasicConsumer consumer, s
try
{
AddConsumer(consumer, consumerTag);
WorkStruct work = WorkStruct.CreateConsumeOk(consumer, consumerTag);
WorkStruct work = WorkStruct.CreateConsumeOk(consumer, consumerTag, _shutdownCts);
await _writer.WriteAsync(work, cancellationToken)
.ConfigureAwait(false);
}
Expand All @@ -113,7 +114,7 @@ public async ValueTask HandleBasicDeliverAsync(string consumerTag, ulong deliver
if (false == _disposed && false == IsQuiescing)
{
IAsyncBasicConsumer consumer = GetConsumerOrDefault(consumerTag);
var work = WorkStruct.CreateDeliver(consumer, consumerTag, deliveryTag, redelivered, exchange, routingKey, basicProperties, body);
var work = WorkStruct.CreateDeliver(consumer, consumerTag, deliveryTag, redelivered, exchange, routingKey, basicProperties, body, _shutdownCts);
await _writer.WriteAsync(work, cancellationToken)
.ConfigureAwait(false);
}
Expand All @@ -126,7 +127,7 @@ public async ValueTask HandleBasicCancelOkAsync(string consumerTag, Cancellation
if (false == _disposed && false == IsQuiescing)
{
IAsyncBasicConsumer consumer = GetAndRemoveConsumer(consumerTag);
WorkStruct work = WorkStruct.CreateCancelOk(consumer, consumerTag);
WorkStruct work = WorkStruct.CreateCancelOk(consumer, consumerTag, _shutdownCts);
await _writer.WriteAsync(work, cancellationToken)
.ConfigureAwait(false);
}
Expand All @@ -139,18 +140,31 @@ public async ValueTask HandleBasicCancelAsync(string consumerTag, CancellationTo
if (false == _disposed && false == IsQuiescing)
{
IAsyncBasicConsumer consumer = GetAndRemoveConsumer(consumerTag);
WorkStruct work = WorkStruct.CreateCancel(consumer, consumerTag);
WorkStruct work = WorkStruct.CreateCancel(consumer, consumerTag, _shutdownCts);
await _writer.WriteAsync(work, cancellationToken)
.ConfigureAwait(false);
}
}

public void Quiesce()
{
if (IsQuiescing)
{
return;
}

Interlocked.Exchange(ref _isQuiescing, 1);
try
{
_shutdownCts.Cancel();
}
catch
{
// ignore
}
}

public async Task WaitForShutdownAsync()
public async Task WaitForShutdownAsync(CancellationToken cancellationToken)
{
if (_disposed)
{
Expand All @@ -169,7 +183,7 @@ public async Task WaitForShutdownAsync()
*
* await _reader.Completion.ConfigureAwait(false);
*/
await _worker
await _worker.WaitAsync(cancellationToken)
.ConfigureAwait(false);
}
catch (AggregateException aex)
Expand Down Expand Up @@ -203,18 +217,13 @@ protected bool IsQuiescing
{
get
{
if (Interlocked.Read(ref _isQuiescing) == 1)
{
return true;
}

return false;
return Interlocked.Read(ref _isQuiescing) == 1;
}
}

protected sealed override void ShutdownConsumer(IAsyncBasicConsumer consumer, ShutdownEventArgs reason)
{
_writer.TryWrite(WorkStruct.CreateShutdown(consumer, reason));
_writer.TryWrite(WorkStruct.CreateShutdown(consumer, reason, _shutdownCts));
}

protected override Task InternalShutdownAsync()
Expand All @@ -237,25 +246,32 @@ protected override Task InternalShutdownAsync()
public readonly RentedMemory Body;
public readonly ShutdownEventArgs? Reason;
public readonly WorkType WorkType;
public readonly CancellationToken CancellationToken;
private readonly CancellationTokenSource? _cancellationTokenSource;

private WorkStruct(WorkType type, IAsyncBasicConsumer consumer, string consumerTag)
private WorkStruct(WorkType type, IAsyncBasicConsumer consumer, string consumerTag, CancellationToken cancellationToken)
: this()
{
WorkType = type;
Consumer = consumer;
ConsumerTag = consumerTag;
CancellationToken = cancellationToken;
_cancellationTokenSource = null;
}

private WorkStruct(IAsyncBasicConsumer consumer, ShutdownEventArgs reason)
private WorkStruct(IAsyncBasicConsumer consumer, ShutdownEventArgs reason, CancellationTokenSource? cancellationTokenSource)
: this()
{
WorkType = WorkType.Shutdown;
Consumer = consumer;
Reason = reason;
CancellationToken = cancellationTokenSource?.Token ?? CancellationToken.None;
this._cancellationTokenSource = cancellationTokenSource;
}

private WorkStruct(IAsyncBasicConsumer consumer, string consumerTag, ulong deliveryTag, bool redelivered,
string exchange, string routingKey, IReadOnlyBasicProperties basicProperties, RentedMemory body)
string exchange, string routingKey, IReadOnlyBasicProperties basicProperties, RentedMemory body,
CancellationToken cancellationToken)
{
WorkType = WorkType.Deliver;
Consumer = consumer;
Expand All @@ -266,37 +282,62 @@ private WorkStruct(IAsyncBasicConsumer consumer, string consumerTag, ulong deliv
RoutingKey = routingKey;
BasicProperties = basicProperties;
Body = body;
Reason = default;
Reason = null;
CancellationToken = cancellationToken;
_cancellationTokenSource = null;
}

public static WorkStruct CreateCancel(IAsyncBasicConsumer consumer, string consumerTag)
public static WorkStruct CreateCancel(IAsyncBasicConsumer consumer, string consumerTag, CancellationTokenSource cancellationTokenSource)
{
return new WorkStruct(WorkType.Cancel, consumer, consumerTag);
return new WorkStruct(WorkType.Cancel, consumer, consumerTag, cancellationTokenSource.Token);
}

public static WorkStruct CreateCancelOk(IAsyncBasicConsumer consumer, string consumerTag)
public static WorkStruct CreateCancelOk(IAsyncBasicConsumer consumer, string consumerTag, CancellationTokenSource cancellationTokenSource)
{
return new WorkStruct(WorkType.CancelOk, consumer, consumerTag);
return new WorkStruct(WorkType.CancelOk, consumer, consumerTag, cancellationTokenSource.Token);
}

public static WorkStruct CreateConsumeOk(IAsyncBasicConsumer consumer, string consumerTag)
public static WorkStruct CreateConsumeOk(IAsyncBasicConsumer consumer, string consumerTag, CancellationTokenSource cancellationTokenSource)
{
return new WorkStruct(WorkType.ConsumeOk, consumer, consumerTag);
return new WorkStruct(WorkType.ConsumeOk, consumer, consumerTag, cancellationTokenSource.Token);
}

public static WorkStruct CreateShutdown(IAsyncBasicConsumer consumer, ShutdownEventArgs reason)
public static WorkStruct CreateShutdown(IAsyncBasicConsumer consumer, ShutdownEventArgs reason, CancellationTokenSource cancellationTokenSource)
{
return new WorkStruct(consumer, reason);
// Create a linked CTS so the shutdown args token reflects both dispatcher cancellation and any upstream token.
CancellationTokenSource? linked = null;
try
{
if (reason.CancellationToken.CanBeCanceled)
{
linked = CancellationTokenSource.CreateLinkedTokenSource(cancellationTokenSource.Token, reason.CancellationToken);
}
}
catch
{
linked = null;
}

CancellationToken token = linked?.Token ?? cancellationTokenSource.Token;
ShutdownEventArgs argsWithToken = reason.Exception != null ?
new ShutdownEventArgs(reason.Initiator, reason.ReplyCode, reason.ReplyText, reason.Exception, token) :
new ShutdownEventArgs(reason.Initiator, reason.ReplyCode, reason.ReplyText, reason.ClassId, reason.MethodId, reason.Cause, token);

return new WorkStruct(consumer, argsWithToken, linked);
}

public static WorkStruct CreateDeliver(IAsyncBasicConsumer consumer, string consumerTag, ulong deliveryTag, bool redelivered,
string exchange, string routingKey, IReadOnlyBasicProperties basicProperties, RentedMemory body)
string exchange, string routingKey, IReadOnlyBasicProperties basicProperties, RentedMemory body, CancellationTokenSource cancellationTokenSource)
{
return new WorkStruct(consumer, consumerTag, deliveryTag, redelivered,
exchange, routingKey, basicProperties, body);
exchange, routingKey, basicProperties, body, cancellationTokenSource.Token);
}

public void Dispose() => Body.Dispose();
public void Dispose()
{
Body.Dispose();
_cancellationTokenSource?.Dispose();
}
}

protected enum WorkType : byte
Expand All @@ -317,6 +358,7 @@ protected virtual void Dispose(bool disposing)
if (disposing)
{
Quiesce();
_shutdownCts.Dispose();
}
}
catch
Expand Down
2 changes: 1 addition & 1 deletion projects/RabbitMQ.Client/ConsumerDispatching/IConsumerDispatcher.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ ValueTask HandleBasicDeliverAsync(string consumerTag,
void Quiesce();

Task ShutdownAsync(ShutdownEventArgs reason);
Task WaitForShutdownAsync();
Task WaitForShutdownAsync(CancellationToken cancellationToken);
}
}
9 changes: 9 additions & 0 deletions projects/RabbitMQ.Client/IChannel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,13 +257,22 @@ ValueTask BasicRejectAsync(ulong deliveryTag, bool requeue,
Task CloseAsync(ushort replyCode, string replyText, bool abort,
CancellationToken cancellationToken = default);

/// <summary>
/// Asynchronously close this session.
/// </summary>
/// <param name="reason">The <see cref="ShutdownEventArgs"/> instance containing the close data.</param>
/// <param name="abort">Whether or not the close is an abort (ignoring certain exceptions).</param>
/// <returns></returns>
Task CloseAsync(ShutdownEventArgs reason, bool abort);

/// <summary>
/// Asynchronously close this session.
/// </summary>
/// <param name="reason">The <see cref="ShutdownEventArgs"/> instance containing the close data.</param>
/// <param name="abort">Whether or not the close is an abort (ignoring certain exceptions).</param>
/// <param name="cancellationToken">CancellationToken for this operation.</param>
/// <returns></returns>
[Obsolete("7.2.0 - cancellationToken is ignored")]
Task CloseAsync(ShutdownEventArgs reason, bool abort,
CancellationToken cancellationToken = default);

Expand Down
48 changes: 41 additions & 7 deletions projects/RabbitMQ.Client/IConnectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,21 +93,36 @@ public static Task CloseAsync(this IConnection connection, ushort reasonCode, st
/// </summary>
/// <remarks>
/// Note that all active channels and sessions will be closed if this method is called.
/// In comparison to normal <see cref="CloseAsync(IConnection, CancellationToken)"/> method, <see cref="AbortAsync(IConnection)"/> will not throw
/// In comparison to normal <see cref="CloseAsync(IConnection, CancellationToken)"/> method, <see cref="AbortAsync(IConnection, CancellationToken)"/> will not throw
/// <see cref="IOException"/> during closing connection.
///This method waits infinitely for the in-progress close operation to complete.
/// </remarks>
public static Task AbortAsync(this IConnection connection)
{
return connection.CloseAsync(Constants.ReplySuccess, "Connection close forced", InternalConstants.DefaultConnectionAbortTimeout, true,
CancellationToken.None);
return connection.CloseAsync(Constants.ReplySuccess, "Connection close forced",
InternalConstants.DefaultConnectionAbortTimeout, true, default);
}

/// <summary>
/// Asynchronously abort this connection and all its channels.
/// </summary>
/// <remarks>
/// Note that all active channels and sessions will be closed if this method is called.
/// In comparison to normal <see cref="CloseAsync(IConnection, CancellationToken)"/> method, <see cref="AbortAsync(IConnection, CancellationToken)"/> will not throw
/// <see cref="IOException"/> during closing connection.
///This method waits infinitely for the in-progress close operation to complete.
/// </remarks>
public static Task AbortAsync(this IConnection connection, CancellationToken cancellationToken = default)
{
return connection.CloseAsync(Constants.ReplySuccess, "Connection close forced",
InternalConstants.DefaultConnectionAbortTimeout, true, cancellationToken);
}

/// <summary>
/// Asynchronously abort this connection and all its channels.
/// </summary>
/// <remarks>
/// The method behaves in the same way as <see cref="AbortAsync(IConnection)"/>, with the only
/// The method behaves in the same way as <see cref="AbortAsync(IConnection, CancellationToken)"/>, with the only
/// difference that the connection is closed with the given connection close code and message.
/// <para>
/// The close code (See under "Reply Codes" in the AMQP 0-9-1 specification)
Expand All @@ -118,16 +133,35 @@ public static Task AbortAsync(this IConnection connection)
/// </remarks>
public static Task AbortAsync(this IConnection connection, ushort reasonCode, string reasonText)
{
return connection.CloseAsync(reasonCode, reasonText, InternalConstants.DefaultConnectionAbortTimeout, true,
CancellationToken.None);
return connection.CloseAsync(reasonCode, reasonText,
InternalConstants.DefaultConnectionAbortTimeout, true, default);
}

/// <summary>
/// Asynchronously abort this connection and all its channels.
/// </summary>
/// <remarks>
/// The method behaves in the same way as <see cref="AbortAsync(IConnection, CancellationToken)"/>, with the only
/// difference that the connection is closed with the given connection close code and message.
/// <para>
/// The close code (See under "Reply Codes" in the AMQP 0-9-1 specification)
/// </para>
/// <para>
/// A message indicating the reason for closing the connection
/// </para>
/// </remarks>
public static Task AbortAsync(this IConnection connection, ushort reasonCode, string reasonText, CancellationToken cancellationToken = default)
{
return connection.CloseAsync(reasonCode, reasonText,
InternalConstants.DefaultConnectionAbortTimeout, true, cancellationToken);
}

/// <summary>
/// Asynchronously abort this connection and all its channels and wait with a
/// timeout for all the in-progress close operations to complete.
/// </summary>
/// <remarks>
/// This method, behaves in a similar way as method <see cref="AbortAsync(IConnection)"/> with the
/// This method, behaves in a similar way as method <see cref="AbortAsync(IConnection, CancellationToken)"/> with the
/// only difference that it explicitly specifies a timeout given
/// for all the in-progress close operations to complete.
/// If timeout is reached and the close operations haven't finished, then socket is forced to close.
Expand Down
4 changes: 4 additions & 0 deletions projects/RabbitMQ.Client/Impl/AsyncEventingWrapper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ private readonly async Task InternalInvoke(Delegate[] handlers, object sender, T
await action(sender, @event)
.ConfigureAwait(false);
}
catch (OperationCanceledException)
{
// Ignore cancellation exceptions
}
catch (Exception exception)
{
if (_onException != null)
Expand Down
Loading