FIxed examples and made summary for RabbitMQ options.

Author: antonyvorontsov

examples/Examples.ConsumerConsole/CustomAsyncMessageHandler.cs

@@ -15,7 +15,7 @@ public CustomAsyncMessageHandler(ILogger<CustomAsyncMessageHandler> logger)
 
         public async Task Handle(string message, string routingKey)
         {
-            await Task.Run(() => _logger.LogInformation("A weird example of runnig something async.")).ConfigureAwait(false);
+            _logger.LogInformation($"A weird example of running something async with message {message}.");
         }
     }
 }

examples/Examples.ConsumerConsole/CustomAsyncNonCyclicMessageHandler.cs

@@ -15,7 +15,7 @@ public CustomAsyncNonCyclicMessageHandler(ILogger<CustomAsyncNonCyclicMessageHan
 
         public async Task Handle(string message, string routingKey, IQueueService queueService)
         {
-            _logger.LogInformation("A weird example of runnig something async.");
+            _logger.LogInformation("A weird example of running something async.");
             var response = new { message, routingKey };
             await queueService.SendAsync(response, "exchange.name", "routing.key");
         }

examples/Examples.ConsumerConsole/Program.cs

@@ -32,8 +32,8 @@ static void ConfigureServices(IServiceCollection services)
 
             services.AddRabbitMqClient(rabbitMqSection)
                 .AddConsumptionExchange("exchange.name", exchangeSection)
-                .AddAsyncMessageHandlerSingleton<CustomAsyncMessageHandler>("routing.key")
-                .AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("routing.key");
+                .AddAsyncMessageHandlerSingleton<CustomAsyncMessageHandler>("routing.key");
+                //.AddAsyncNonCyclicMessageHandlerSingleton<CustomAsyncNonCyclicMessageHandler>("routing.key");
         }
     }
 }

examples/Examples.ConsumerConsole/appsettings.json

@@ -5,7 +5,12 @@
     }
   },
   "RabbitMq": {
-    "HostName": "127.0.0.1",
+    "TcpEndpoints": [
+      {
+        "HostName": "127.0.0.1",
+        "Port": 5672
+      }
+    ],
     "Port": "5672",
     "UserName": "guest",
     "Password": "guest"

examples/Examples.ConsumerHost/Program.cs

@@ -27,8 +27,8 @@ public static async Task Main()
 
                   services.AddRabbitMqClient(rabbitMqSection)
                       .AddConsumptionExchange("exchange.name", exchangeSection)
-                      .AddMessageHandlerTransient<CustomMessageHandler>("routing.key")
-                      .AddNonCyclicMessageHandlerSingleton<CustomNonCyclicMessageHandler>("routing.key");
+                      .AddMessageHandlerTransient<CustomMessageHandler>("routing.key");
+                      //.AddNonCyclicMessageHandlerSingleton<CustomNonCyclicMessageHandler>("routing.key");
 
                   services.AddSingleton<IHostedService, ConsumingService>();
               });

src/RabbitMQ.Client.Core.DependencyInjection/Configuration/RabbitMqClientOptions.cs

@@ -8,27 +8,35 @@ namespace RabbitMQ.Client.Core.DependencyInjection.Configuration
     public class RabbitMqClientOptions
     {
         /// <summary>
-        /// RabbitMQ server.
+        /// Collection of AMPQ TCP endpoints.
+        /// It can be used when RabbitMQ HA cluster is set up and you have to connect multiple hosts with different ports.
         /// </summary>
-        public string HostName { get; set; } = "127.0.0.1";
+        /// <remarks>
+        /// Has the first priority between properties TcpEndpoints, HostNames and HostName.
+        /// If all properties are set, TcpEndpoints will be used.
+        /// </remarks>
+        public IEnumerable<RabbitMqTcpEndpoint> TcpEndpoints { get; set; }
 
         /// <summary>
         /// Collection of RabbitMQ server host names.
-        /// </summary>
-        /// <remarks>
         /// It can be used when RabbitMQ HA cluster is set up and you have to connect multiple hosts.
         /// If HostNames collection is null or empty then HostName will be used to create connection.
         /// Otherwise HostNames collection will be used and HostName property value will be ignored.
+        /// </summary>
+        /// <remarks>
+        /// Has the second priority between properties TcpEndpoints, HostNames and HostName.
+        /// If HostNames collection property and HostName property both set then HostNames will be used.
         /// </remarks>
         public IEnumerable<string> HostNames { get; set; }
-        
+
         /// <summary>
-        /// Collection of AMPQ TCP endpoints.
+        /// RabbitMQ server.
         /// </summary>
         /// <remarks>
-        /// Usage is the same as collection of HostNames but 
+        /// Has the third priority between properties TcpEndpoints, HostNames and HostName.
+        /// HostName will be used if only TcpEndpoints and HostNames properties are not set.
         /// </remarks>
-        public IEnumerable<RabbitMqTcpEndpoint> TcpEndpoints { get; set; }
+        public string HostName { get; set; } = "127.0.0.1";
 
         /// <summary>
         /// Port.

src/RabbitMQ.Client.Core.DependencyInjection/Configuration/RabbitMqTcpEndpoint.cs

@@ -9,7 +9,7 @@ public class RabbitMqTcpEndpoint
         /// RabbitMQ server.
         /// </summary>
         public string HostName { get; set; }
-        
+
         /// <summary>
         /// Tcp connection port.
         /// </summary>

src/RabbitMQ.Client.Core.DependencyInjection/QueueService.cs

@@ -555,15 +555,15 @@ static IConnection CreateRabbitMqConnection(RabbitMqClientOptions options)
                 RequestedConnectionTimeout = options.RequestedConnectionTimeout,
                 RequestedHeartbeat = options.RequestedHeartbeat
             };
-            
+
             if (options.TcpEndpoints?.Any() == true)
             {
                 var clientEndpoints = options.TcpEndpoints.Select(x => new AmqpTcpEndpoint(x.HostName, x.Port)).ToList();
                 return factory.CreateConnection(clientEndpoints);
             }
-            
-            return string.IsNullOrEmpty(options.ClientProvidedName) 
-                ? CreateConnection(options, factory) 
+
+            return string.IsNullOrEmpty(options.ClientProvidedName)
+                ? CreateConnection(options, factory)
                 : CreateNamedConnection(options, factory);
         }