Add IConnection XML doc

Author: lukebakken

RabbitMQ.AMQP.Client/ConnectionExceptions.cs

@@ -0,0 +1,28 @@
+// This source code is dual-licensed under the Apache License, version 2.0,
+// and the Mozilla Public License, version 2.0.
+// Copyright (c) 2017-2024 Broadcom. All Rights Reserved. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
+
+using System;
+
+namespace RabbitMQ.AMQP.Client
+{
+    /// <summary>
+    /// Exception related to <see cref="IConnection"/>
+    /// </summary>
+    public class ConnectionException : Exception
+    {
+        /// <summary>
+        /// Create a <see cref="ConnectionException"/> with the specified message.
+        /// </summary>
+        public ConnectionException(string message) : base(message)
+        {
+        }
+
+        /// <summary>
+        /// Create a <see cref="ConnectionException"/> with the specified message and inner <see cref="Exception"/>.
+        /// </summary>
+        public ConnectionException(string message, Exception innerException) : base(message, innerException)
+        {
+        }
+    }
+}

RabbitMQ.AMQP.Client/IConnection.cs

@@ -2,40 +2,60 @@
 // and the Mozilla Public License, version 2.0.
 // Copyright (c) 2017-2024 Broadcom. All Rights Reserved. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 
-using System;
 using System.Collections.Generic;
 
 namespace RabbitMQ.AMQP.Client
 {
-    public class ConnectionException : Exception
-    {
-        public ConnectionException(string message) : base(message)
-        {
-        }
-
-        public ConnectionException(string message, Exception innerException) : base(message, innerException)
-        {
-        }
-    }
-
     public interface IConnection : ILifeCycle
     {
+        /// <summary>
+        /// The <see cref="IManagement"/> instance for this connection.
+        /// </summary>
+        /// <returns><see cref="IManagement"/> instance for this connection.</returns>
         IManagement Management();
 
+        /// <summary>
+        /// Create an <see cref="IPublisherBuilder"/> instance for this connection.
+        /// </summary>
+        /// <returns><see cref="IPublisherBuilder"/> instance for this connection.</returns>
         IPublisherBuilder PublisherBuilder();
 
+        /// <summary>
+        /// Create an <see cref="IConsumerBuilder"/> instance for this connection.
+        /// </summary>
+        /// <returns><see cref="IConsumerBuilder"/> instance for this connection.</returns>
         IConsumerBuilder ConsumerBuilder();
 
+        /// <summary>
+        /// Create an <see cref="IRpcServerBuilder"/> instance for this connection.
+        /// </summary>
+        /// <returns><see cref="IRpcServerBuilder"/> instance for this connection.</returns>
         IRpcServerBuilder RpcServerBuilder();
 
+        /// <summary>
+        /// Create an <see cref="IRpcClientBuilder"/> instance for this connection.
+        /// </summary>
+        /// <returns><see cref="IRpcClientBuilder"/> instance for this connection.</returns>
         IRpcClientBuilder RpcClientBuilder();
 
+        /// <summary>
+        /// Get the properties for this connection.
+        /// </summary>
         public IReadOnlyDictionary<string, object> Properties { get; }
 
+        /// <summary>
+        /// Get the <see cref="IPublisher"/> instances associated with this connection.
+        /// </summary>
         public IEnumerable<IPublisher> Publishers { get; }
 
+        /// <summary>
+        /// Get the <see cref="IConsumer"/> instances associated with this connection.
+        /// </summary>
         public IEnumerable<IConsumer> Consumers { get; }
 
+        /// <summary>
+        /// Get or set the Connection ID
+        /// </summary>
         public long Id { get; set; }
     }
 }

RabbitMQ.AMQP.Client/Impl/AmqpConnection.cs

@@ -37,9 +37,6 @@ public class AmqpConnection : AbstractLifeCycle, IConnection
         private readonly ConnectionSettings _connectionSettings;
         private readonly IMetricsReporter? _metricsReporter;
 
-        // TODO this is coupled with publishers and consumers
-        internal readonly AmqpSessionManagement _nativePubSubSessions;
-
         private readonly Dictionary<string, object> _connectionProperties = new();
         private bool _areFilterExpressionsSupported = false;
 
@@ -59,47 +56,12 @@ public class AmqpConnection : AbstractLifeCycle, IConnection
         /// </summary>
         private readonly ConcurrentDictionary<Guid, IConsumer> _consumersDict = new();
 
-        // TODO this couples AmqpConnection with AmqpPublisher, yuck
-        internal void AddPublisher(Guid id, IPublisher consumer)
-        {
-            if (false == _publishersDict.TryAdd(id, consumer))
-            {
-                // TODO create "internal bug" exception type?
-                throw new InvalidOperationException("could not add publisher, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
-            }
-        }
-
-        internal void RemovePublisher(Guid id)
-        {
-            if (false == _publishersDict.TryRemove(id, out _))
-            {
-                // TODO create "internal bug" exception type?
-                throw new InvalidOperationException("could not remove publisher, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
-            }
-        }
-
-        // TODO this couples AmqpConnection with AmqpConsumer, yuck
-        internal void AddConsumer(Guid id, IConsumer consumer)
-        {
-            if (false == _consumersDict.TryAdd(id, consumer))
-            {
-                // TODO create "internal bug" exception type?
-                throw new InvalidOperationException("could not add consumer, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
-            }
-        }
-
-        internal void RemoveConsumer(Guid id)
-        {
-            if (false == _consumersDict.TryRemove(id, out _))
-            {
-                // TODO create "internal bug" exception type?
-                throw new InvalidOperationException("could not remove consumer, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
-            }
-        }
-
         private readonly TaskCompletionSource<bool> _connectionClosedTcs =
             Utils.CreateTaskCompletionSource<bool>();
 
+        // TODO this is coupled with publishers and consumers
+        internal readonly AmqpSessionManagement _nativePubSubSessions;
+
         public IRpcServerBuilder RpcServerBuilder()
         {
             return new AmqpRpcServerBuilder(this);
@@ -164,6 +126,13 @@ public IConsumerBuilder ConsumerBuilder()
             return new AmqpConsumerBuilder(this, _metricsReporter);
         }
 
+        public IPublisherBuilder PublisherBuilder()
+        {
+            ThrowIfClosed();
+            var publisherBuilder = new AmqpPublisherBuilder(this, _metricsReporter);
+            return publisherBuilder;
+        }
+
         // TODO cancellation token
         public override async Task OpenAsync()
         {
@@ -174,13 +143,6 @@ await base.OpenAsync()
                 .ConfigureAwait(false);
         }
 
-        public IPublisherBuilder PublisherBuilder()
-        {
-            ThrowIfClosed();
-            var publisherBuilder = new AmqpPublisherBuilder(this, _metricsReporter);
-            return publisherBuilder;
-        }
-
         public override async Task CloseAsync()
         {
             await _semaphoreClose.WaitAsync()
@@ -229,10 +191,6 @@ public override string ToString()
             return info;
         }
 
-        internal Connection? NativeConnection => _nativeConnection;
-
-        internal bool AreFilterExpressionsSupported => _areFilterExpressionsSupported;
-
         protected override void Dispose(bool disposing)
         {
             if (disposing)
@@ -250,6 +208,48 @@ protected override void Dispose(bool disposing)
             base.Dispose(disposing);
         }
 
+        internal Connection? NativeConnection => _nativeConnection;
+
+        internal bool AreFilterExpressionsSupported => _areFilterExpressionsSupported;
+
+        // TODO this couples AmqpConnection with AmqpPublisher, yuck
+        internal void AddPublisher(Guid id, IPublisher consumer)
+        {
+            if (false == _publishersDict.TryAdd(id, consumer))
+            {
+                // TODO create "internal bug" exception type?
+                throw new InvalidOperationException("could not add publisher, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
+            }
+        }
+
+        internal void RemovePublisher(Guid id)
+        {
+            if (false == _publishersDict.TryRemove(id, out _))
+            {
+                // TODO create "internal bug" exception type?
+                throw new InvalidOperationException("could not remove publisher, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
+            }
+        }
+
+        // TODO this couples AmqpConnection with AmqpConsumer, yuck
+        internal void AddConsumer(Guid id, IConsumer consumer)
+        {
+            if (false == _consumersDict.TryAdd(id, consumer))
+            {
+                // TODO create "internal bug" exception type?
+                throw new InvalidOperationException("could not add consumer, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
+            }
+        }
+
+        internal void RemoveConsumer(Guid id)
+        {
+            if (false == _consumersDict.TryRemove(id, out _))
+            {
+                // TODO create "internal bug" exception type?
+                throw new InvalidOperationException("could not remove consumer, report via https://github.com/rabbitmq/rabbitmq-amqp-dotnet-client/issues");
+            }
+        }
+
         /// <summary>
         /// Closes all the publishers. It is called when the connection is closed.
         /// </summary>
@@ -619,71 +619,4 @@ private void HandleProperties(Fields properties)
             _areFilterExpressionsSupported = Utils.SupportsFilterExpressions(brokerVersion);
         }
     }
-
-    internal class Visitor : IVisitor
-    {
-        private readonly AmqpManagement _management;
-
-        internal Visitor(AmqpManagement management)
-        {
-            _management = management;
-        }
-
-        public async Task VisitQueuesAsync(IEnumerable<QueueSpec> queueSpec)
-        {
-            // TODO this could be done in parallel
-            foreach (QueueSpec spec in queueSpec)
-            {
-                Trace.WriteLine(TraceLevel.Information, $"Recovering queue {spec.QueueName}");
-                try
-                {
-                    await _management.Queue(spec).DeclareAsync()
-                        .ConfigureAwait(false);
-                }
-                catch (Exception e)
-                {
-                    Trace.WriteLine(TraceLevel.Error,
-                        $"Error recovering queue {spec.QueueName}. Error: {e}. Management Status: {_management}");
-                }
-            }
-        }
-
-        public async Task VisitExchangesAsync(IEnumerable<ExchangeSpec> exchangeSpec)
-        {
-            // TODO this could be done in parallel
-            foreach (ExchangeSpec spec in exchangeSpec)
-            {
-                Trace.WriteLine(TraceLevel.Information, $"Recovering exchange {spec.ExchangeName}");
-                try
-                {
-                    await _management.Exchange(spec).DeclareAsync()
-                        .ConfigureAwait(false);
-                }
-                catch (Exception e)
-                {
-                    Trace.WriteLine(TraceLevel.Error,
-                        $"Error recovering exchange {spec.ExchangeName}. Error: {e}. Management Status: {_management}");
-                }
-            }
-        }
-
-        public async Task VisitBindingsAsync(IEnumerable<BindingSpec> bindingSpec)
-        {
-            // TODO this could be done in parallel
-            foreach (BindingSpec spec in bindingSpec)
-            {
-                Trace.WriteLine(TraceLevel.Information, $"Recovering binding {spec.BindingPath}");
-                try
-                {
-                    await _management.Binding(spec).BindAsync()
-                        .ConfigureAwait(false);
-                }
-                catch (Exception e)
-                {
-                    Trace.WriteLine(TraceLevel.Error,
-                        $"Error recovering binding {spec.BindingPath}. Error: {e}. Management Status: {_management}");
-                }
-            }
-        }
-    }
 }

RabbitMQ.AMQP.Client/Impl/RecordingTopologyListener.cs

@@ -8,13 +8,6 @@
 
 namespace RabbitMQ.AMQP.Client.Impl
 {
-    internal interface IVisitor
-    {
-        Task VisitQueuesAsync(IEnumerable<QueueSpec> queueSpec);
-        Task VisitExchangesAsync(IEnumerable<ExchangeSpec> exchangeSpec);
-        Task VisitBindingsAsync(IEnumerable<BindingSpec> bindingSpec);
-    }
-
     /// <summary>
     /// RecordingTopologyListener is a concrete implementation of <see cref="ITopologyListener"/>
     ///  It is used to record the topology of the entities declared in the AMQP server ( like queues, exchanges, etc)