Skip to content

Commit e6e8b5c

Browse files
committed
Rename several methods in AsyncEventingBasicConsumer to use Async suffix.
1 parent 4be0367 commit e6e8b5c

18 files changed

+72
-74
lines changed

projects/Benchmarks/ConsumerDispatching/AsyncBasicConsumerFake.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ public Task HandleBasicDeliverAsync(string consumerTag, ulong deliveryTag, bool
3737

3838
public Task HandleChannelShutdownAsync(object channel, ShutdownEventArgs reason) => Task.CompletedTask;
3939

40-
public Task OnCancelAsync(string[] consumerTags, CancellationToken cancellationToken = default) => Task.CompletedTask;
41-
4240
public IChannel Channel { get; }
4341
}
4442
}

projects/RabbitMQ.Client/PublicAPI.Shipped.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -246,10 +246,6 @@ RabbitMQ.Client.EndpointResolverExtensions
246246
RabbitMQ.Client.Events.AsyncEventHandler<TEvent>
247247
RabbitMQ.Client.Events.AsyncEventingBasicConsumer
248248
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.AsyncEventingBasicConsumer(RabbitMQ.Client.IChannel channel) -> void
249-
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Received -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.Events.BasicDeliverEventArgs>
250-
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Registered -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.Events.ConsumerEventArgs>
251-
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Shutdown -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.ShutdownEventArgs>
252-
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.Unregistered -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.Events.ConsumerEventArgs>
253249
RabbitMQ.Client.Events.BaseExceptionEventArgs
254250
RabbitMQ.Client.Events.BasicAckEventArgs
255251
RabbitMQ.Client.Events.BasicDeliverEventArgs
@@ -900,3 +896,7 @@ virtual RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicCancelOkAsync(strin
900896
virtual RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicConsumeOkAsync(string! consumerTag, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
901897
virtual RabbitMQ.Client.AsyncDefaultBasicConsumer.HandleBasicDeliverAsync(string! consumerTag, ulong deliveryTag, bool redelivered, string! exchange, string! routingKey, RabbitMQ.Client.IReadOnlyBasicProperties! properties, System.ReadOnlyMemory<byte> body, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
902898
virtual RabbitMQ.Client.AsyncDefaultBasicConsumer.OnCancelAsync(string![]! consumerTags, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
899+
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.ShutdownAsync -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.ShutdownEventArgs!>!
900+
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.UnregisteredAsync -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.Events.ConsumerEventArgs!>!
901+
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.RegisteredAsync -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.Events.ConsumerEventArgs!>!
902+
RabbitMQ.Client.Events.AsyncEventingBasicConsumer.ReceivedAsync -> RabbitMQ.Client.Events.AsyncEventHandler<RabbitMQ.Client.Events.BasicDeliverEventArgs!>!

projects/RabbitMQ.Client/client/events/AsyncEventingBasicConsumer.cs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,45 +20,45 @@ public AsyncEventingBasicConsumer(IChannel channel) : base(channel)
2020
/// Accessing the body at a later point is unsafe as its memory can
2121
/// be already released.
2222
/// </remarks>
23-
public event AsyncEventHandler<BasicDeliverEventArgs> Received
23+
public event AsyncEventHandler<BasicDeliverEventArgs> ReceivedAsync
2424
{
25-
add => _receivedWrapper.AddHandler(value);
26-
remove => _receivedWrapper.RemoveHandler(value);
25+
add => _receivedAsyncWrapper.AddHandler(value);
26+
remove => _receivedAsyncWrapper.RemoveHandler(value);
2727
}
28-
private AsyncEventingWrapper<BasicDeliverEventArgs> _receivedWrapper;
28+
private AsyncEventingWrapper<BasicDeliverEventArgs> _receivedAsyncWrapper;
2929

3030
///<summary>Fires when the server confirms successful consumer registration.</summary>
31-
public event AsyncEventHandler<ConsumerEventArgs> Registered
31+
public event AsyncEventHandler<ConsumerEventArgs> RegisteredAsync
3232
{
33-
add => _registeredWrapper.AddHandler(value);
34-
remove => _registeredWrapper.RemoveHandler(value);
33+
add => _registeredAsyncWrapper.AddHandler(value);
34+
remove => _registeredAsyncWrapper.RemoveHandler(value);
3535
}
36-
private AsyncEventingWrapper<ConsumerEventArgs> _registeredWrapper;
36+
private AsyncEventingWrapper<ConsumerEventArgs> _registeredAsyncWrapper;
3737

3838
///<summary>Fires on channel shutdown, both client and server initiated.</summary>
39-
public event AsyncEventHandler<ShutdownEventArgs> Shutdown
39+
public event AsyncEventHandler<ShutdownEventArgs> ShutdownAsync
4040
{
41-
add => _shutdownWrapper.AddHandler(value);
42-
remove => _shutdownWrapper.RemoveHandler(value);
41+
add => _shutdownAsyncWrapper.AddHandler(value);
42+
remove => _shutdownAsyncWrapper.RemoveHandler(value);
4343
}
44-
private AsyncEventingWrapper<ShutdownEventArgs> _shutdownWrapper;
44+
private AsyncEventingWrapper<ShutdownEventArgs> _shutdownAsyncWrapper;
4545

4646
///<summary>Fires when the server confirms successful consumer cancellation.</summary>
47-
public event AsyncEventHandler<ConsumerEventArgs> Unregistered
47+
public event AsyncEventHandler<ConsumerEventArgs> UnregisteredAsync
4848
{
49-
add => _unregisteredWrapper.AddHandler(value);
50-
remove => _unregisteredWrapper.RemoveHandler(value);
49+
add => _unregisteredAsyncWrapper.AddHandler(value);
50+
remove => _unregisteredAsyncWrapper.RemoveHandler(value);
5151
}
52-
private AsyncEventingWrapper<ConsumerEventArgs> _unregisteredWrapper;
52+
private AsyncEventingWrapper<ConsumerEventArgs> _unregisteredAsyncWrapper;
5353

5454
///<summary>Fires when the server confirms successful consumer cancellation.</summary>
5555
protected override async Task OnCancelAsync(string[] consumerTags, CancellationToken cancellationToken = default)
5656
{
5757
await base.OnCancelAsync(consumerTags, cancellationToken)
5858
.ConfigureAwait(false);
59-
if (!_unregisteredWrapper.IsEmpty)
59+
if (!_unregisteredAsyncWrapper.IsEmpty)
6060
{
61-
await _unregisteredWrapper.InvokeAsync(this, new ConsumerEventArgs(consumerTags, cancellationToken))
61+
await _unregisteredAsyncWrapper.InvokeAsync(this, new ConsumerEventArgs(consumerTags, cancellationToken))
6262
.ConfigureAwait(false);
6363
}
6464
}
@@ -68,9 +68,9 @@ public override async Task HandleBasicConsumeOkAsync(string consumerTag, Cancell
6868
{
6969
await base.HandleBasicConsumeOkAsync(consumerTag, cancellationToken)
7070
.ConfigureAwait(false);
71-
if (!_registeredWrapper.IsEmpty)
71+
if (!_registeredAsyncWrapper.IsEmpty)
7272
{
73-
await _registeredWrapper.InvokeAsync(this, new ConsumerEventArgs(new[] { consumerTag }, cancellationToken))
73+
await _registeredAsyncWrapper.InvokeAsync(this, new ConsumerEventArgs(new[] { consumerTag }, cancellationToken))
7474
.ConfigureAwait(false);
7575
}
7676
}
@@ -82,17 +82,17 @@ public override Task HandleBasicDeliverAsync(string consumerTag, ulong deliveryT
8282
var deliverEventArgs = new BasicDeliverEventArgs(consumerTag, deliveryTag, redelivered, exchange, routingKey, properties, body, cancellationToken);
8383

8484
// No need to call base, it's empty.
85-
return _receivedWrapper.InvokeAsync(this, deliverEventArgs);
85+
return _receivedAsyncWrapper.InvokeAsync(this, deliverEventArgs);
8686
}
8787

8888
///<summary>Fires the Shutdown event.</summary>
8989
public override async Task HandleChannelShutdownAsync(object channel, ShutdownEventArgs reason)
9090
{
9191
await base.HandleChannelShutdownAsync(channel, reason)
9292
.ConfigureAwait(false);
93-
if (!_shutdownWrapper.IsEmpty)
93+
if (!_shutdownAsyncWrapper.IsEmpty)
9494
{
95-
await _shutdownWrapper.InvokeAsync(this, reason)
95+
await _shutdownAsyncWrapper.InvokeAsync(this, reason)
9696
.ConfigureAwait(false);
9797
}
9898
}

projects/RabbitMQ.Client/client/events/BasicDeliverEventArgs.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public BasicDeliverEventArgs(string consumerTag,
6767
/// </para>
6868
/// <para>
6969
/// NOTE: Using this memory outside of
70-
/// <c><seealso cref="AsyncEventingBasicConsumer.Received"/></c>
70+
/// <c><seealso cref="AsyncEventingBasicConsumer.ReceivedAsync"/></c>
7171
/// requires that it be copied!
7272
/// <example>
7373
/// This shows how to copy the data for use:

projects/Test/Applications/MassPublish/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ await consumeChannel.QueueDeclareAsync(queue: QueueName,
8181
passive: false, durable: false, exclusive: false, autoDelete: false, arguments: null);
8282

8383
var asyncListener = new AsyncEventingBasicConsumer(consumeChannel);
84-
asyncListener.Received += AsyncListener_Received;
84+
asyncListener.ReceivedAsync += AsyncListener_Received;
8585

8686
await consumeChannel.QueueBindAsync(queue: QueueName, exchange: ExchangeName, routingKey: RoutingKey, arguments: null);
8787

projects/Test/Integration/ConnectionRecovery/TestConnectionRecovery.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ await _channel.ExchangeDeclareAsync(exchange: exchangeName,
9393
await _channel.QueueBindAsync(queue: queueName, exchange: exchangeName, routingKey: routingKey);
9494

9595
var consumer = new AsyncEventingBasicConsumer(_channel);
96-
consumer.Received += MessageReceived;
96+
consumer.ReceivedAsync += MessageReceived;
9797
await _channel.BasicConsumeAsync(queueName, true, consumer);
9898

9999
using (IChannel pubCh = await _conn.CreateChannelAsync())

projects/Test/Integration/TestAsyncConsumer.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public async Task TestBasicRoundtripConcurrent()
105105
return Task.CompletedTask;
106106
};
107107

108-
consumer.Received += (o, a) =>
108+
consumer.ReceivedAsync += (o, a) =>
109109
{
110110
if (ByteArraysEqual(a.Body.Span, body1))
111111
{
@@ -274,7 +274,7 @@ public async Task TestBasicRoundtripConcurrentManyMessages()
274274
};
275275

276276
var consumer = new AsyncEventingBasicConsumer(consumeChannel);
277-
consumer.Received += (o, a) =>
277+
consumer.ReceivedAsync += (o, a) =>
278278
{
279279
if (ByteArraysEqual(a.Body.ToArray(), body1))
280280
{
@@ -370,7 +370,7 @@ public async Task TestBasicRejectAsync()
370370
};
371371

372372
var consumer = new AsyncEventingBasicConsumer(_channel);
373-
consumer.Received += async (object sender, BasicDeliverEventArgs args) =>
373+
consumer.ReceivedAsync += async (object sender, BasicDeliverEventArgs args) =>
374374
{
375375
var c = sender as AsyncEventingBasicConsumer;
376376
Assert.Same(c, consumer);
@@ -470,7 +470,7 @@ public async Task TestBasicAckAsync()
470470
await _channel.ConfirmSelectAsync();
471471

472472
var consumer = new AsyncEventingBasicConsumer(_channel);
473-
consumer.Received += async (object sender, BasicDeliverEventArgs args) =>
473+
consumer.ReceivedAsync += async (object sender, BasicDeliverEventArgs args) =>
474474
{
475475
var c = sender as AsyncEventingBasicConsumer;
476476
Assert.NotNull(c);
@@ -534,7 +534,7 @@ public async Task TestBasicNackAsync()
534534
};
535535

536536
var consumer = new AsyncEventingBasicConsumer(_channel);
537-
consumer.Received += async (object sender, BasicDeliverEventArgs args) =>
537+
consumer.ReceivedAsync += async (object sender, BasicDeliverEventArgs args) =>
538538
{
539539
var c = sender as AsyncEventingBasicConsumer;
540540
Assert.NotNull(c);
@@ -651,7 +651,7 @@ public async Task TestCreateChannelWithinAsyncConsumerCallback_GH650()
651651
await _channel.QueueBindAsync(queue2Name, exchangeName, queue2Name);
652652

653653
var consumer1 = new AsyncEventingBasicConsumer(_channel);
654-
consumer1.Received += async (sender, args) =>
654+
consumer1.ReceivedAsync += async (sender, args) =>
655655
{
656656
using (IChannel innerChannel = await _conn.CreateChannelAsync())
657657
{
@@ -666,7 +666,7 @@ await innerChannel.BasicPublishAsync(exchangeName, queue2Name,
666666
await _channel.BasicConsumeAsync(queue1Name, autoAck: true, consumer1);
667667

668668
var consumer2 = new AsyncEventingBasicConsumer(_channel);
669-
consumer2.Received += async (sender, args) =>
669+
consumer2.ReceivedAsync += async (sender, args) =>
670670
{
671671
tcs.TrySetResult(true);
672672
await Task.Yield();
@@ -691,7 +691,7 @@ public async Task TestCloseWithinEventHandler_GH1567()
691691
string queueName = q.QueueName;
692692

693693
var consumer = new AsyncEventingBasicConsumer(_channel);
694-
consumer.Received += async (_, eventArgs) =>
694+
consumer.ReceivedAsync += async (_, eventArgs) =>
695695
{
696696
await _channel.BasicCancelAsync(eventArgs.ConsumerTag);
697697
#pragma warning disable CS4014 // Because this call is not awaited, execution of the current method continues before the call is completed

projects/Test/Integration/TestAsyncConsumerCancelNotify.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public async Task TestCorrectConsumerTag()
7474
string consumerTag2 = await _channel.BasicConsumeAsync(q2, true, consumer);
7575

7676
string notifiedConsumerTag = null;
77-
consumer.Unregistered += (sender, args) =>
77+
consumer.UnregisteredAsync += (sender, args) =>
7878
{
7979
notifiedConsumerTag = args.ConsumerTags.First();
8080
_tcs.TrySetResult(true);
@@ -111,7 +111,7 @@ public CancelNotificationConsumer(IChannel channel, TestAsyncConsumerCancelNotif
111111
_eventMode = eventMode;
112112
if (eventMode)
113113
{
114-
Unregistered += CancelledAsync;
114+
UnregisteredAsync += CancelledAsync;
115115
}
116116
}
117117

projects/Test/Integration/TestAsyncConsumerOperationDispatch.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ public async Task TestChannelShutdownDoesNotShutDownDispatcher()
169169
var tcs = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
170170
await ch1.BasicConsumeAsync(q1, true, new AsyncEventingBasicConsumer(ch1));
171171
var c2 = new AsyncEventingBasicConsumer(ch2);
172-
c2.Received += (object sender, BasicDeliverEventArgs e) =>
172+
c2.ReceivedAsync += (object sender, BasicDeliverEventArgs e) =>
173173
{
174174
tcs.SetResult(true);
175175
return Task.CompletedTask;

projects/Test/Integration/TestAsyncEventingBasicConsumer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ public async Task TestAsyncEventingBasicConsumer_GH1038()
101101

102102
//async subscriber
103103
var consumer = new AsyncEventingBasicConsumer(_channel);
104-
consumer.Received += AsyncConsumerOnReceived;
104+
consumer.ReceivedAsync += AsyncConsumerOnReceived;
105105
await _channel.BasicConsumeAsync(queueName, false, consumer);
106106

107107
//publisher

0 commit comments

Comments
 (0)