RabbitMQ delivery limit check documentation and upgrade guide

Snippets/Rabbit/Rabbit.sln

@@ -17,6 +17,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Rabbit_9.1", "Rabbit_9.1\Ra
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Rabbit_9.2", "Rabbit_9.2\Rabbit_9.2.csproj", "{2F242592-4E40-4C87-90A4-32055B11544F}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Rabbit_10", "Rabbit_10\Rabbit_10.csproj", "{F99C022C-1BAD-4C78-8069-C34C3EB9AE5F}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -51,6 +53,10 @@ Global
 		{2F242592-4E40-4C87-90A4-32055B11544F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{2F242592-4E40-4C87-90A4-32055B11544F}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{2F242592-4E40-4C87-90A4-32055B11544F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{F99C022C-1BAD-4C78-8069-C34C3EB9AE5F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{F99C022C-1BAD-4C78-8069-C34C3EB9AE5F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{F99C022C-1BAD-4C78-8069-C34C3EB9AE5F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{F99C022C-1BAD-4C78-8069-C34C3EB9AE5F}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

Snippets/Rabbit/Rabbit_10/AccessToBasicDeliverEventArgs.cs

@@ -0,0 +1,18 @@
+using System;
+using System.Threading.Tasks;
+using NServiceBus.Pipeline;
+using RabbitMQ.Client.Events;
+
+#region rabbitmq-access-to-event-args
+class AccessToBasicDeliverEventArgs : Behavior<IIncomingContext>
+{
+    public override Task Invoke(IIncomingContext context, Func<Task> next)
+    {
+        var userIdOnBroker = context.Extensions.Get<BasicDeliverEventArgs>().BasicProperties.UserId;
+
+        //do something useful
+
+        return next();
+    }
+}
+#endregion

Snippets/Rabbit/Rabbit_10/MyRoutingTopology.cs

@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using NServiceBus.Transport;
+using NServiceBus.Transport.RabbitMQ;
+using NServiceBus.Unicast.Messages;
+using RabbitMQ.Client;
+
+class MyRoutingTopology :
+    IRoutingTopology
+{
+    public MyRoutingTopology(bool createDurableExchangesAndQueues)
+    {
+    }
+
+    public void SetupSubscription(IModel channel, MessageMetadata type, string subscriberName)
+    {
+    }
+
+    public void TeardownSubscription(IModel channel, MessageMetadata type, string subscriberName)
+    {
+    }
+
+    public void Publish(IModel channel, Type type, OutgoingMessage message, IBasicProperties properties)
+    {
+    }
+
+    public void Send(IModel channel, string address, OutgoingMessage message, IBasicProperties properties)
+    {
+    }
+
+    public void RawSendInCaseOfFailure(IModel channel, string address, ReadOnlyMemory<byte> body, IBasicProperties properties)
+    {
+    }
+
+    public void Initialize(IModel channel, IEnumerable<string> receivingAddresses, IEnumerable<string> sendingAddresses)
+    {
+    }
+
+    public void BindToDelayInfrastructure(IModel channel, string address, string deliveryExchange, string routingKey)
+    {
+    }
+}

Snippets/Rabbit/Rabbit_10/OutgoingNativeMessageCustomization.cs

@@ -0,0 +1,23 @@
+using NServiceBus;
+
+class OutgoingNativeMessageCustomization
+{
+    OutgoingNativeMessageCustomization(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-customize-outgoing-message
+
+        var rabbitMqTransport = new RabbitMQTransport(
+            routingTopology: RoutingTopology.Conventional(QueueType.Classic),
+            connectionString: "host=localhost;username=rabbitmq;password=rabbitmq",
+            enableDelayedDelivery: false
+        );
+
+        rabbitMqTransport.OutgoingNativeMessageCustomization = (operation, properties) =>
+        {
+            //Set values on IBasicProperties
+            properties.ContentType = "application/my-type";
+        };
+
+        #endregion
+    }
+}

Snippets/Rabbit/Rabbit_10/RabbitMQNonPersistentDeliveryMode.cs

@@ -0,0 +1,19 @@
+using System.Threading.Tasks;
+using NServiceBus;
+
+class RabbitMQNonPersistentDeliveryMode
+{
+    public async Task RequestNonPersistent(IMessageHandlerContext context)
+    {
+        #region rabbitmq-non-persistent-delivery-mode
+        var options = new SendOptions();
+
+        options.RouteToThisEndpoint();
+        options.UseNonPersistentDeliveryMode();
+
+        await context.Send(new MyMessage(), options);
+        #endregion
+    }
+
+    class MyMessage { }
+}

Snippets/Rabbit/Rabbit_10/Rabbit_10.csproj

@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="NServiceBus.RabbitMQ" Version="10.0.0-alpha.0.92" />
+    <!--<PackageReference Include="NServiceBus.RabbitMQ" Version="9.1.*" />-->
+  </ItemGroup>
+
+</Project>

Snippets/Rabbit/Rabbit_10/Usage.cs

@@ -0,0 +1,229 @@
+using System;
+using System.Security.Cryptography.X509Certificates;
+
+using NServiceBus;
+
+class Usage
+{
+    Usage(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-basic
+
+        endpointConfiguration.UseTransport<RabbitMQTransport>();
+
+        #endregion
+    }
+
+    void CustomConnectionString(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-connectionstring-in-code
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.ConnectionString("My custom connection string");
+
+        #endregion
+    }
+
+    void CustomIdStrategy(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-custom-id-strategy
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.CustomMessageIdStrategy(
+            customIdStrategy: deliveryArgs =>
+            {
+                var headers = deliveryArgs.BasicProperties.Headers;
+                return headers["MyCustomId"].ToString();
+            });
+
+        #endregion
+    }
+
+    void UseConventionalRoutingTopology(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-useconventionalroutingtopology
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.UseConventionalRoutingTopology(QueueType.Quorum);
+
+        #endregion
+    }
+
+    void UseDirectRoutingTopology(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-usedirectroutingtopology
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.UseDirectRoutingTopology(QueueType.Quorum);
+
+        #endregion
+    }
+
+    void UseDirectRoutingTopologyWithCustomConventions(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-usedirectroutingtopologywithcustomconventions
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.UseDirectRoutingTopology(
+            QueueType.Quorum,
+            routingKeyConvention: MyRoutingKeyConvention,
+            exchangeNameConvention: () => "MyTopic");
+
+        #endregion
+    }
+
+    string MyRoutingKeyConvention(Type type)
+    {
+        throw new NotImplementedException();
+    }
+
+    void UseRoutingTopology5_0(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-useroutingtopologyDelegate
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.UseCustomRoutingTopology(
+            topologyFactory: createDurableExchangesAndQueues =>
+            {
+                return new MyRoutingTopology(createDurableExchangesAndQueues);
+            });
+
+        #endregion
+    }
+
+    void UseCustomCircuitBreakerSettings(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-custom-breaker-settings-time-to-wait-before-triggering-code
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.TimeToWaitBeforeTriggeringCircuitBreaker(TimeSpan.FromMinutes(2));
+
+        #endregion
+    }
+
+    void PrefetchMultiplier(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-prefetch-multiplier
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.PrefetchMultiplier(4);
+
+        #endregion
+    }
+
+    void PrefetchCount(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-config-prefetch-count
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.PrefetchCount(100);
+
+        #endregion
+    }
+
+    void SetClientCertificateFile(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-client-certificate-file
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.SetClientCertificate("path", "password");
+
+        #endregion
+    }
+
+    void SetClientCertificate(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-client-certificate
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.SetClientCertificate(new X509Certificate2("/path/to/certificate"));
+
+        #endregion
+    }
+
+    void DisableRemoteCertificateValidation(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-disable-remote-certificate-validation
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.DisableRemoteCertificateValidation();
+
+        #endregion
+    }
+
+    void UseExternalAuthMechanism(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-external-auth-mechanism
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.UseExternalAuthMechanism();
+
+        #endregion
+    }
+
+    void ChangeRequestedHeartbeatForDebugging(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-debug-api
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.SetHeartbeatInterval(TimeSpan.FromMinutes(10));
+
+        #endregion
+    }
+
+    void ChangeHeartbeatInterval(EndpointConfiguration endpointConfiguration)
+    {
+        #region change-heartbeat-interval
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.SetHeartbeatInterval(TimeSpan.FromSeconds(30));
+
+        #endregion
+    }
+
+    void ChangeNetworkRecoveryInterval(EndpointConfiguration endpointConfiguration)
+    {
+        #region change-network-recovery-interval
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.SetNetworkRecoveryInterval(TimeSpan.FromSeconds(30));
+
+        #endregion
+    }
+
+    void DisableDurableExchangesAndQueues(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-disable-durable-exchanges
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.DisableDurableExchangesAndQueues();
+
+        #endregion
+    }
+
+    void AddClusterNode(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-add-cluster-node
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.AddClusterNode("node2", useTls: false);
+
+        #endregion
+
+        #region rabbitmq-add-cluster-node-with-port
+
+        transport.AddClusterNode("node2", 5675, useTls: true);
+
+        #endregion
+    }
+
+    void SetManagementApiUrl(EndpointConfiguration endpointConfiguration)
+    {
+        #region rabbitmq-management-api-url
+
+        var transport = endpointConfiguration.UseTransport<RabbitMQTransport>();
+        transport.ManagementApiUrl("http://{username}:{password}@{host}:{port}");
+
+        #endregion
+    }
+}

Snippets/Rabbit/Rabbit_10/rabbitmq-connection-tls.txt

@@ -0,0 +1,3 @@
+startcode rabbitmq-connection-tls
+host=broker1;UseTls=true
+endcode

transports/rabbitmq/connection-settings.md

@@ -101,6 +101,8 @@ snippet: rabbitmq-external-auth-mechanism
 
 partial: add-cluster-node
 
+partial: management-api-url
+
 ## Controlling the prefetch count
 
 When consuming messages from the broker, throughput can be improved by having the consumer [prefetch](https://www.rabbitmq.com/consumer-prefetch.html) additional messages.