Consumer cancellation event

Author: Emile Joubert

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

@@ -108,6 +108,12 @@
     <Compile Include="..\RabbitMQ.Client\src\client\events\FlowControlEventHandler.cs">
       <Link>src\client\events\FlowControlEventHandler.cs</Link>
     </Compile>
+    <Compile Include="..\RabbitMQ.Client\src\client\events\ConsumerCancelledEventHandler.cs">
+      <Link>src\client\events\ConsumerCancelledEventHandler.cs</Link>
+    </Compile>
+    <Compile Include="..\RabbitMQ.Client\src\client\events\ConsumerEventArgs.cs">
+      <Link>src\client\events\ConsumerEventArgs.cs</Link>
+    </Compile>
     <Compile Include="properties\AssemblyInfo.cs" />
   </ItemGroup>
 

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

@@ -39,6 +39,8 @@
 //---------------------------------------------------------------------------
 
 using System;
+using RabbitMQ.Client.Events;
+using RabbitMQ.Client.Impl;
 
 namespace RabbitMQ.Client
 {
@@ -60,6 +62,8 @@ public class DefaultBasicConsumer : IBasicConsumer
         private string m_consumerTag = null;
         private bool m_running = false;
         private ShutdownEventArgs m_shutdownReason = null;
+        public readonly object m_eventLock = new object();
+        public ConsumerCancelledEventHandler m_consumerCancelled;
 
         ///<summary>Retrieve the IModel instance this consumer is
         ///registered with.</summary>
@@ -113,6 +117,18 @@ public DefaultBasicConsumer(IModel model)
         public virtual void OnCancel()
         {
             m_running = false;
+            ConsumerCancelledEventHandler handler;
+            lock (m_eventLock)
+            {
+                handler = m_consumerCancelled;
+            }
+            if (handler != null)
+            {
+                foreach (ConsumerCancelledEventHandler h in handler.GetInvocationList())
+                {
+                    h(this, new ConsumerEventArgs(m_consumerTag));
+                }
+            }
         }
 
 
@@ -145,6 +161,24 @@ public virtual void HandleModelShutdown(IModel model, ShutdownEventArgs reason)
             OnCancel();
         }
 
+        public event ConsumerCancelledEventHandler ConsumerCancelled
+        {
+            add
+            {
+                lock (m_eventLock)
+                {
+                    m_consumerCancelled += value;
+                }
+            }
+            remove
+            {
+                lock (m_eventLock)
+                {
+                    m_consumerCancelled -= value;
+                }
+            }
+        }
+
         ///<summary>Default implementation - override in subclasses.</summary>
         ///<remarks>
         /// Does nothing with the passed in information. Note that in

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

@@ -39,6 +39,7 @@
 //---------------------------------------------------------------------------
 
 using System;
+using RabbitMQ.Client.Events;
 
 namespace RabbitMQ.Client
 {
@@ -92,5 +93,10 @@ void HandleBasicDeliver(string consumerTag,
                                 string routingKey,
                                 IBasicProperties properties,
                                 byte[] body);
+
+
+
+        ///<summary>Signalled when the consumer gets cancelled.</summary>
+        event ConsumerCancelledEventHandler ConsumerCancelled;
     }
 }

projects/client/RabbitMQ.Client/src/client/events/ConsumerCancelledEventHandler.cs

@@ -0,0 +1,50 @@
+// 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-2013 GoPivotal, 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 GoPivotal, Inc.
+//  Copyright (c) 2013-2013 GoPivotal, Inc.  All rights reserved.
+//---------------------------------------------------------------------------
+
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace RabbitMQ.Client.Events
+{
+    ///<summary>Delegate used to process consumer cancellations.
+    ///</summary>
+    public delegate void ConsumerCancelledEventHandler(object sender, ConsumerEventArgs args);
+}