bug24281 merged into default (queue-declare-ok)

Author: Marek Majkowski

projects/client/ApigenBootstrap/RabbitMQ.Client.ApigenBootstrap.csproj

@@ -66,6 +66,9 @@
     <Compile Include="..\RabbitMQ.Client\src\client\api\PublicationAddress.cs">
       <Link>src\client\api\PublicationAddress.cs</Link>
     </Compile>
+    <Compile Include="..\RabbitMQ.Client\src\client\api\QueueDeclareOk.cs">
+      <Link>src\client\api\QueueDeclareOk.cs</Link>
+    </Compile>
     <Compile Include="..\RabbitMQ.Client\src\client\api\ShutdownEventArgs.cs">
       <Link>src\client\api\ShutdownEventArgs.cs</Link>
     </Compile>

projects/client/RabbitMQ.Client/src/client/api/IModel.cs

@@ -242,7 +242,7 @@ void ExchangeUnbind(string destination,
         ///name is the return value of this method.
         ///</remarks>
         [AmqpMethodDoNotImplement(null)]
-        string QueueDeclare();
+        QueueDeclareOk QueueDeclare();
 
         ///<summary>Declare a queue passively.</summary>
         ///<remarks>
@@ -251,11 +251,11 @@ void ExchangeUnbind(string destination,
         ///The queue is declared passively; i.e. only check if it exists.
         ///</remarks>
         [AmqpMethodDoNotImplement(null)]
-        string QueueDeclarePassive(string queue);
+        QueueDeclareOk QueueDeclarePassive(string queue);
 
         ///<summary>(Spec method) Declare a queue.</summary>
         [AmqpMethodDoNotImplement(null)]
-        string QueueDeclare(string queue, bool durable, bool exclusive,
+        QueueDeclareOk QueueDeclare(string queue, bool durable, bool exclusive,
                     bool autoDelete, IDictionary arguments);
 
         ///<summary>(Spec method) Bind a queue to an exchange.</summary>
@@ -663,15 +663,21 @@ void _Private_ExchangeUnbind(string destination,
         ///<summary>Used to send a Queue.Declare method. Called by the
         ///public declare method.</summary>
         [AmqpMethodMapping(null, "queue", "declare")]
-        [return: AmqpFieldMapping(null, "queue")]
-        string _Private_QueueDeclare(string queue,
-                                     bool passive,
-                                     bool durable,
-                                     bool exclusive,
-                                     bool autoDelete,
-                                     [AmqpNowaitArgument(null)]
-                                     bool nowait,
-                                     IDictionary arguments);
+        [AmqpForceOneWay]
+        void _Private_QueueDeclare(string queue,
+                                   bool passive,
+                                   bool durable,
+                                   bool exclusive,
+                                   bool autoDelete,
+                                   [AmqpNowaitArgument(null)]
+                                   bool nowait,
+                                   IDictionary arguments);
+
+        ///<summary>Handle incoming Queue.DeclareOk methods. Routes the
+        ///information to a waiting Queue.DeclareOk continuation.</summary>
+        void HandleQueueDeclareOk(string queue,
+                                  uint messageCount,
+                                  uint consumerCount);
 
         ///<summary>Used to send a Queue.Bind method. Called by the
         ///public bind method.</summary>

projects/client/RabbitMQ.Client/src/client/api/QueueDeclareOk.cs

@@ -0,0 +1,59 @@
+// This source code is dual-licensed under the Apache License, version
+// 2.0, and the Mozilla Public License, version 1.1.
+//
+// The APL v2.0:
+//
+//---------------------------------------------------------------------------
+//   Copyright (C) 2007-2011 VMware, Inc.
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+//---------------------------------------------------------------------------
+//
+// The MPL v1.1:
+//
+//---------------------------------------------------------------------------
+//  The contents of this file are subject to the Mozilla Public License
+//  Version 1.1 (the "License"); you may not use this file except in
+//  compliance with the License. You may obtain a copy of the License
+//  at http://www.mozilla.org/MPL/
+//
+//  Software distributed under the License is distributed on an "AS IS"
+//  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+//  the License for the specific language governing rights and
+//  limitations under the License.
+//
+//  The Original Code is RabbitMQ.
+//
+//  The Initial Developer of the Original Code is VMware, Inc.
+//  Copyright (c) 2007-2011 VMware, Inc.  All rights reserved.
+//---------------------------------------------------------------------------
+
+namespace RabbitMQ.Client
+{
+    public class QueueDeclareOk {
+        public string QueueName { get; private set; }
+        public uint MessageCount { get; private set; }
+        public uint ConsumerCount { get; private set; }
+
+        public QueueDeclareOk(string queueName, uint messageCount, uint consumerCount) {
+            this.QueueName = queueName;
+            this.MessageCount = messageCount;
+            this.ConsumerCount = consumerCount;
+        }
+
+        public static implicit operator string(QueueDeclareOk declareOk)
+        {
+            return declareOk.QueueName;
+        }
+    }
+}

projects/client/RabbitMQ.Client/src/client/impl/ModelBase.cs

@@ -851,29 +851,54 @@ public abstract void _Private_ExchangeUnbind(string destination,
 
         //TODO: Mark these as virtual, maybe the model has an optimized way
         //      of dealing with missing parameters.
-        public string QueueDeclare()
+        public QueueDeclareOk QueueDeclare()
         {
             return QueueDeclare("", false, true, true, null);
         }
 
-        public string QueueDeclarePassive(string queue)
+        public QueueDeclareOk QueueDeclarePassive(string queue)
         {
-            return _Private_QueueDeclare(queue, true, false, false, false, false, null);
+            return QueueDeclare(queue, true, false, false, false, null);
         }
 
-        public string QueueDeclare(string queue, bool durable, bool exclusive,
+        public QueueDeclareOk QueueDeclare(string queue, bool durable, bool exclusive,
                                    bool autoDelete, IDictionary arguments)
         {
-            return _Private_QueueDeclare(queue, false, durable, exclusive, autoDelete, false, arguments);
+            return QueueDeclare(queue, false, durable, exclusive, autoDelete, arguments);
         }
 
-        public abstract string _Private_QueueDeclare(string queue,
-                                                     bool passive,
-                                                     bool durable,
-                                                     bool exclusive,
-                                                     bool autoDelete,
-                                                     bool nowait,
-                                                     IDictionary arguments);
+        public class QueueDeclareRpcContinuation : SimpleBlockingRpcContinuation
+        {
+            public QueueDeclareOk m_result;
+            public QueueDeclareRpcContinuation() { }
+        }
+
+        private QueueDeclareOk QueueDeclare(string queue, bool passive, bool durable, bool exclusive,
+                                                   bool autoDelete, IDictionary arguments)
+        {
+            QueueDeclareRpcContinuation k = new QueueDeclareRpcContinuation();
+            Enqueue(k);
+            try
+            {
+                _Private_QueueDeclare(queue, passive, durable, exclusive, autoDelete, false, arguments);
+            }
+            catch (AlreadyClosedException)
+            {
+                // Ignored, since the continuation will be told about
+                // the closure via an OperationInterruptedException because
+                // of the shutdown event propagation.
+            }
+            k.GetReply();
+            return k.m_result;
+        }
+
+        public abstract void _Private_QueueDeclare(string queue,
+                                                   bool passive,
+                                                   bool durable,
+                                                   bool exclusive,
+                                                   bool autoDelete,
+                                                   bool nowait,
+                                                   IDictionary arguments);
 
         public void QueueBind(string queue,
                               string exchange,
@@ -1473,6 +1498,17 @@ public abstract void _Private_ConnectionClose(ushort replyCode,
 
         public abstract void _Private_ConnectionCloseOk();
 
+        public void HandleQueueDeclareOk(string queue,
+                                         uint messageCount,
+                                         uint consumerCount)
+        {
+            QueueDeclareRpcContinuation k = (QueueDeclareRpcContinuation)m_continuationQueue.Next();
+            k.m_result = new QueueDeclareOk(queue,
+                                            messageCount,
+                                            consumerCount);
+            k.HandleCommand(null); // release the continuation.
+        }
+
         public override string ToString() {
             return m_session.ToString();
         }

projects/client/Unit/src/unit/TestComplexResults.cs

@@ -0,0 +1,91 @@
+// This source code is dual-licensed under the Apache License, version
+// 2.0, and the Mozilla Public License, version 1.1.
+//
+// The APL v2.0:
+//
+//---------------------------------------------------------------------------
+//   Copyright (C) 2007-2011 VMware, Inc.
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+//---------------------------------------------------------------------------
+//
+// The MPL v1.1:
+//
+//---------------------------------------------------------------------------
+//  The contents of this file are subject to the Mozilla Public License
+//  Version 1.1 (the "License"); you may not use this file except in
+//  compliance with the License. You may obtain a copy of the License
+//  at http://www.mozilla.org/MPL/
+//
+//  Software distributed under the License is distributed on an "AS IS"
+//  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+//  the License for the specific language governing rights and
+//  limitations under the License.
+//
+//  The Original Code is RabbitMQ.
+//
+//  The Initial Developer of the Original Code is VMware, Inc.
+//  Copyright (c) 2007-2011 VMware, Inc.  All rights reserved.
+//---------------------------------------------------------------------------
+
+using System;
+using NUnit.Framework;
+using RabbitMQ.Client.Exceptions;
+
+namespace RabbitMQ.Client.Unit
+{
+    [TestFixture]
+    public class TestComplexResults : IntegrationFixture
+    {
+
+        private readonly String QueueName = "declare-ok-test-queue";
+
+        [Test]
+        public void TestQueueDeclareOk()
+        {
+            QueueDeclareOk result;
+
+            result = QueueDeclare();
+            Assert.AreEqual(0, result.MessageCount);
+            Assert.AreEqual(0, result.ConsumerCount);
+            Assert.AreEqual(QueueName, result.QueueName);
+            Model.BasicPublish("", result.QueueName, null, new byte[] { });
+
+            result = QueueDeclare();
+            Assert.AreEqual(1, result.MessageCount);
+            Assert.AreEqual(0, result.ConsumerCount);
+            Assert.AreEqual(QueueName, result.QueueName);
+
+            QueueingBasicConsumer consumer = new QueueingBasicConsumer(Model);
+            Model.BasicConsume(QueueName, true, consumer);
+            consumer.Queue.Dequeue();
+
+            result = QueueDeclare();
+            Assert.AreEqual(0, result.MessageCount);
+            Assert.AreEqual(1, result.ConsumerCount);
+            Assert.AreEqual(QueueName, result.QueueName);
+        }
+
+        [Test]
+        public void TestQueueDeclarePassive()
+        {
+            Assert.Throws(Is.TypeOf<OperationInterruptedException>(),
+                          delegate { Model.QueueDeclarePassive(QueueName); });
+        }
+
+        private QueueDeclareOk QueueDeclare()
+        {
+            return Model.QueueDeclare(QueueName, false, true, true, null);
+        }
+    }
+}