Skip to content

Commit dd5f2ed

Browse files
authored
renaming (#137)
Signed-off-by: Gabriele Santomaggio <G.santomaggio@gmail.com>
1 parent f724e23 commit dd5f2ed

File tree

8 files changed

+33
-33
lines changed

8 files changed

+33
-33
lines changed

RabbitMQ.AMQP.Client/IRequester.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public interface IRequesterAddressBuilder : IAddressBuilder<IRequesterAddressBui
1414
}
1515

1616
/// <summary>
17-
/// IRpcClientBuilder is the interface for creating an RPC client.
17+
/// IRequesterBuilder is the interface for creating an RPC client.
1818
/// See also <seealso cref="IRequester"/> and <seealso cref="IResponderBuilder"/>
1919
/// </summary>
2020
public interface IRequesterBuilder

RabbitMQ.AMQP.Client/IResponder.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public interface IResponderBuilder
5050
/// </summary>
5151
/// <param name="handler"></param>
5252
/// <returns></returns>
53-
IResponderBuilder Handler(RpcHandler handler);
53+
IResponderBuilder Handler(ResponderHandler handler);
5454

5555
/// <summary>
5656
/// Build and return the RPC server.
@@ -63,7 +63,7 @@ public interface IResponderBuilder
6363
/// Event handler for handling RPC requests.
6464
/// </summary>
6565
// TODO cancellation token
66-
public delegate Task<IMessage> RpcHandler(IResponder.IContext context, IMessage request);
66+
public delegate Task<IMessage> ResponderHandler(IResponder.IContext context, IMessage request);
6767

6868
/// <summary>
6969
/// IResponder interface for creating an RPC server.

RabbitMQ.AMQP.Client/Impl/AmqpRequester.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,14 @@ public async Task<IRequester> BuildAsync()
8181
{
8282
_configuration.RequestAddress = _addressBuilder.Address();
8383
_configuration.Connection = _connection;
84-
var rpcClient = new AmqpRequester(_configuration);
85-
await rpcClient.OpenAsync().ConfigureAwait(false);
86-
return rpcClient;
84+
var amqpRequester = new AmqpRequester(_configuration);
85+
await amqpRequester.OpenAsync().ConfigureAwait(false);
86+
return amqpRequester;
8787
}
8888
}
8989

9090
/// <summary>
91-
/// AmqpRpcClient is an implementation of <see cref="IRequester"/>.
91+
/// AmqpRequester is an implementation of <see cref="IRequester"/>.
9292
/// It is a wrapper around <see cref="IPublisher"/> and <see cref="IConsumer"/> to create an RPC client over AMQP 1.0.
9393
/// even the PublishAsync is async the RPClient blocks the thread until the response is received.
9494
/// within the timeout.

RabbitMQ.AMQP.Client/Impl/AmqpResponder.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ namespace RabbitMQ.AMQP.Client.Impl
1111
public class ResponderConfiguration
1212
{
1313
public AmqpConnection Connection { get; set; } = null!;
14-
public RpcHandler? Handler { get; set; }
14+
public ResponderHandler? Handler { get; set; }
1515
public string RequestQueue { get; set; } = "";
1616
public Func<IMessage, object>? CorrelationIdExtractor { get; set; }
1717
public Func<IMessage, object, IMessage>? ReplyPostProcessor { get; set; }
1818
}
1919

2020
/// <summary>
21-
/// AmqpRpcServerBuilder is a builder for creating an AMQP RPC server.
21+
/// AmqpResponderBuilder is a builder for creating an AMQP RPC server.
2222
/// </summary>
2323
public class AmqpResponderBuilder : IResponderBuilder
2424
{
@@ -53,7 +53,7 @@ public IResponderBuilder ReplyPostProcessor(Func<IMessage, object, IMessage>? re
5353
return this;
5454
}
5555

56-
public IResponderBuilder Handler(RpcHandler handler)
56+
public IResponderBuilder Handler(ResponderHandler handler)
5757
{
5858
_configuration.Handler = handler;
5959
return this;
@@ -68,8 +68,8 @@ public async Task<IResponder> BuildAsync()
6868
}
6969

7070
/// <summary>
71-
/// AmqpRpcServer implements the <see cref="IResponder"/> interface.
72-
/// With the RpcClient you can create an RPC communication over AMQP 1.0.
71+
/// AmqpResponder implements the <see cref="IResponder"/> interface.
72+
/// With the AmqpRequester you can create an RPC communication over AMQP 1.0.
7373
/// </summary>
7474
public class AmqpResponder : AbstractLifeCycle, IResponder
7575
{
@@ -121,7 +121,7 @@ public override async Task OpenAsync()
121121
context.Accept();
122122
if (_configuration.Handler != null)
123123
{
124-
IMessage reply = await _configuration.Handler(new RpcServerContext(), request)
124+
IMessage reply = await _configuration.Handler(new ResponderContext(), request)
125125
.ConfigureAwait(false);
126126

127127
if (request.ReplyTo() != "")
@@ -130,7 +130,7 @@ public override async Task OpenAsync()
130130
}
131131
else
132132
{
133-
Trace.WriteLine(TraceLevel.Error, "[RPC server] No reply-to address in request");
133+
Trace.WriteLine(TraceLevel.Error, "[Responder] No reply-to address in request");
134134
}
135135

136136
object correlationId = ExtractCorrelationId(request);
@@ -145,7 +145,7 @@ await Utils.WaitWithBackOffUntilFuncAsync(async () =>
145145
catch (Exception e)
146146
{
147147
Trace.WriteLine(TraceLevel.Error,
148-
$"[RPC server] Failed to send reply: {e.Message}");
148+
$"[Responder] Failed to send reply: {e.Message}");
149149
return false;
150150
}
151151
},
@@ -164,7 +164,7 @@ await Utils.WaitWithBackOffUntilFuncAsync(async () =>
164164
await base.OpenAsync().ConfigureAwait(false);
165165
}
166166

167-
private class RpcServerContext : IResponder.IContext
167+
private class ResponderContext : IResponder.IContext
168168
{
169169
public IMessage Message(byte[] body) => new AmqpMessage(body);
170170
public IMessage Message(string body) => new AmqpMessage(body);

RabbitMQ.AMQP.Client/PublicAPI.Unshipped.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder
516516
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.AmqpResponderBuilder(RabbitMQ.AMQP.Client.Impl.AmqpConnection! connection) -> void
517517
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.BuildAsync() -> System.Threading.Tasks.Task<RabbitMQ.AMQP.Client.IResponder!>!
518518
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.CorrelationIdExtractor(System.Func<RabbitMQ.AMQP.Client.IMessage!, object!>? correlationIdExtractor) -> RabbitMQ.AMQP.Client.IResponderBuilder!
519-
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.Handler(RabbitMQ.AMQP.Client.RpcHandler! handler) -> RabbitMQ.AMQP.Client.IResponderBuilder!
519+
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.Handler(RabbitMQ.AMQP.Client.ResponderHandler! handler) -> RabbitMQ.AMQP.Client.IResponderBuilder!
520520
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.ReplyPostProcessor(System.Func<RabbitMQ.AMQP.Client.IMessage!, object!, RabbitMQ.AMQP.Client.IMessage!>? replyPostProcessor) -> RabbitMQ.AMQP.Client.IResponderBuilder!
521521
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.RequestQueue(RabbitMQ.AMQP.Client.IQueueSpecification! requestQueue) -> RabbitMQ.AMQP.Client.IResponderBuilder!
522522
RabbitMQ.AMQP.Client.Impl.AmqpResponderBuilder.RequestQueue(string! requestQueue) -> RabbitMQ.AMQP.Client.IResponderBuilder!
@@ -599,7 +599,7 @@ RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.Connection.get -> RabbitMQ.AMQP
599599
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.Connection.set -> void
600600
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.CorrelationIdExtractor.get -> System.Func<RabbitMQ.AMQP.Client.IMessage!, object!>?
601601
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.CorrelationIdExtractor.set -> void
602-
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.Handler.get -> RabbitMQ.AMQP.Client.RpcHandler?
602+
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.Handler.get -> RabbitMQ.AMQP.Client.ResponderHandler?
603603
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.Handler.set -> void
604604
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.ReplyPostProcessor.get -> System.Func<RabbitMQ.AMQP.Client.IMessage!, object!, RabbitMQ.AMQP.Client.IMessage!>?
605605
RabbitMQ.AMQP.Client.Impl.ResponderConfiguration.ReplyPostProcessor.set -> void
@@ -715,7 +715,7 @@ RabbitMQ.AMQP.Client.IResponder.IContext.Message(string! body) -> RabbitMQ.AMQP.
715715
RabbitMQ.AMQP.Client.IResponderBuilder
716716
RabbitMQ.AMQP.Client.IResponderBuilder.BuildAsync() -> System.Threading.Tasks.Task<RabbitMQ.AMQP.Client.IResponder!>!
717717
RabbitMQ.AMQP.Client.IResponderBuilder.CorrelationIdExtractor(System.Func<RabbitMQ.AMQP.Client.IMessage!, object!>? correlationIdExtractor) -> RabbitMQ.AMQP.Client.IResponderBuilder!
718-
RabbitMQ.AMQP.Client.IResponderBuilder.Handler(RabbitMQ.AMQP.Client.RpcHandler! handler) -> RabbitMQ.AMQP.Client.IResponderBuilder!
718+
RabbitMQ.AMQP.Client.IResponderBuilder.Handler(RabbitMQ.AMQP.Client.ResponderHandler! handler) -> RabbitMQ.AMQP.Client.IResponderBuilder!
719719
RabbitMQ.AMQP.Client.IResponderBuilder.ReplyPostProcessor(System.Func<RabbitMQ.AMQP.Client.IMessage!, object!, RabbitMQ.AMQP.Client.IMessage!>? replyPostProcessor) -> RabbitMQ.AMQP.Client.IResponderBuilder!
720720
RabbitMQ.AMQP.Client.IResponderBuilder.RequestQueue(RabbitMQ.AMQP.Client.IQueueSpecification! requestQueue) -> RabbitMQ.AMQP.Client.IResponderBuilder!
721721
RabbitMQ.AMQP.Client.IResponderBuilder.RequestQueue(string! requestQueue) -> RabbitMQ.AMQP.Client.IResponderBuilder!
@@ -789,7 +789,7 @@ RabbitMQ.AMQP.Client.RecoveryConfiguration.IsActivated() -> bool
789789
RabbitMQ.AMQP.Client.RecoveryConfiguration.IsTopologyActive() -> bool
790790
RabbitMQ.AMQP.Client.RecoveryConfiguration.RecoveryConfiguration() -> void
791791
RabbitMQ.AMQP.Client.RecoveryConfiguration.Topology(bool activated) -> RabbitMQ.AMQP.Client.IRecoveryConfiguration!
792-
RabbitMQ.AMQP.Client.RpcHandler
792+
RabbitMQ.AMQP.Client.ResponderHandler
793793
RabbitMQ.AMQP.Client.SaslMechanism
794794
RabbitMQ.AMQP.Client.SaslMechanism.Equals(RabbitMQ.AMQP.Client.SaslMechanism? other) -> bool
795795
RabbitMQ.AMQP.Client.SaslMechanism.Mechanism.get -> string!

Tests/RequesterResponser/RecoveryRPCTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
using Xunit;
1111
using Xunit.Abstractions;
1212

13-
namespace Tests.Rpc
13+
namespace Tests.RequesterResponser
1414
{
1515
public class RecoveryRpcTests(ITestOutputHelper testOutputHelper)
1616
: IntegrationTest(testOutputHelper, setupConnectionAndManagement: false)

Tests/RequesterResponser/ResponderTests.cs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
using Xunit;
1212
using Xunit.Abstractions;
1313

14-
namespace Tests.Rpc
14+
namespace Tests.RequesterResponser
1515
{
1616
public class ResponderTests(ITestOutputHelper testOutputHelper) : IntegrationTest(testOutputHelper)
1717
{
@@ -111,7 +111,7 @@ public async Task SimulateRpcCommunicationWithAPublisherShouldSuccess()
111111
Assert.NotNull(_management);
112112

113113
IResponder responder = await _connection.ResponderBuilder()
114-
.Handler(PongRpcHandler)
114+
.Handler(PongResponderHandler)
115115
.RequestQueue(_requestQueueName)
116116
.BuildAsync();
117117

@@ -163,7 +163,7 @@ public async Task ResponderRequesterPingPongWithDefault()
163163
Assert.NotNull(_connection);
164164

165165
IResponder responder = await _connection.ResponderBuilder()
166-
.Handler(PongRpcHandler)
166+
.Handler(PongResponderHandler)
167167
.RequestQueue(_requestQueueName)
168168
.BuildAsync();
169169

@@ -197,7 +197,7 @@ public async Task ResponderRequesterPingPongWithCustomReplyToQueueAndCorrelation
197197
Assert.NotNull(_management);
198198

199199
IResponder responder = await _connection.ResponderBuilder()
200-
.Handler(PongRpcHandler)
200+
.Handler(PongResponderHandler)
201201
.RequestQueue(_requestQueueName)
202202
.BuildAsync();
203203

@@ -240,7 +240,7 @@ public async Task ResponderRequesterOverridingTheRequestAndResponsePostProcessor
240240
Assert.NotNull(_management);
241241

242242
IResponder responder = await _connection.ResponderBuilder()
243-
.Handler(PongRpcHandler)
243+
.Handler(PongResponderHandler)
244244
.RequestQueue(_requestQueueName)
245245
.CorrelationIdExtractor(message => message.Property("correlationId"))
246246
.ReplyPostProcessor((reply, replyCorrelationId) => reply.Property("correlationId",
@@ -297,7 +297,7 @@ public async Task RequesterMultiThreadShouldBeSafe()
297297
TaskCompletionSource<bool> tcs = CreateTaskCompletionSource();
298298
List<IMessage> messagesReceived = [];
299299

300-
Task<IMessage> RpcHandler(IResponder.IContext context, IMessage request)
300+
Task<IMessage> ResponderHandler(IResponder.IContext context, IMessage request)
301301
{
302302
try
303303
{
@@ -315,7 +315,7 @@ Task<IMessage> RpcHandler(IResponder.IContext context, IMessage request)
315315
}
316316

317317
IResponder responder = await _connection.ResponderBuilder()
318-
.Handler(RpcHandler)
318+
.Handler(ResponderHandler)
319319
.RequestQueue(_requestQueueName)
320320
.BuildAsync();
321321

@@ -358,14 +358,14 @@ Task<IMessage> RpcHandler(IResponder.IContext context, IMessage request)
358358
}
359359

360360
/// <summary>
361-
/// The RPC client `PublishAsync` should raise a timeout exception if the server does not reply within the timeout
361+
/// The Requester `PublishAsync` should raise a timeout exception if the server does not reply within the timeout
362362
/// </summary>
363363
[Fact]
364364
public async Task RequesterShouldRaiseTimeoutError()
365365
{
366366
Assert.NotNull(_connection);
367367

368-
static async Task<IMessage> RpcHandler(IResponder.IContext context, IMessage request)
368+
static async Task<IMessage> RequesterHandler(IResponder.IContext context, IMessage request)
369369
{
370370
IMessage reply = context.Message("pong");
371371
object millisecondsToWait = request.Property("wait");
@@ -374,7 +374,7 @@ static async Task<IMessage> RpcHandler(IResponder.IContext context, IMessage req
374374
}
375375

376376
IResponder responder = await _connection.ResponderBuilder()
377-
.Handler(RpcHandler)
377+
.Handler(RequesterHandler)
378378
.RequestQueue(_requestQueueName)
379379
.BuildAsync();
380380

@@ -396,7 +396,7 @@ await Assert.ThrowsAsync<TimeoutException>(() => requester.PublishAsync(
396396
await responder.CloseAsync();
397397
}
398398

399-
private static Task<IMessage> PongRpcHandler(IResponder.IContext context, IMessage request)
399+
private static Task<IMessage> PongResponderHandler(IResponder.IContext context, IMessage request)
400400
{
401401
IMessage reply = context.Message("pong");
402402
return Task.FromResult(reply);

docs/Examples/Rpc/Program.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
consoleListener.WriteLine($"[{DateTime.Now}] [{l}] - {f}");
1818

1919
Trace.WriteLine(TraceLevel.Information, "Starting the example...");
20-
const string containerId = "rpc-example-connection";
20+
const string containerId = "request-response-example-connection";
2121

2222
var recoveryConfiguration = new RecoveryConfiguration();
2323
recoveryConfiguration.Topology(true);

0 commit comments

Comments
 (0)