merge bug22967 into default (Channel flow in public API)

Author: Alexandru Scvortov

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

@@ -90,6 +90,9 @@
     <Compile Include="..\RabbitMQ.Client\src\client\events\ModelShutdownEventHandler.cs">
       <Link>src\client\events\ModelShutdownEventHandler.cs</Link>
     </Compile>
+    <Compile Include="..\RabbitMQ.Client\src\client\events\FlowControlEventHandler.cs">
+      <Link>src\client\events\FlowControlEventHandler.cs</Link>
+    </Compile>
     <Compile Include="properties\AssemblyInfo.cs" />
   </ItemGroup>
 

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

@@ -93,6 +93,8 @@ public interface IModel: IDisposable
         ///</remarks>
         event CallbackExceptionEventHandler CallbackException;
 
+        event FlowControlEventHandler FlowControl;
+
         ///<summary>All messages received before this fires that haven't been
         ///ack'ed will be redelivered. All messages received afterwards won't
         ///be.

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

@@ -0,0 +1,79 @@
+// 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-2010 LShift Ltd., Cohesive Financial
+//   Technologies LLC., and Rabbit Technologies Ltd.
+//
+//   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.rabbitmq.com/mpl.html
+//
+//   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 The RabbitMQ .NET Client.
+//
+//   The Initial Developers of the Original Code are LShift Ltd,
+//   Cohesive Financial Technologies LLC, and Rabbit Technologies Ltd.
+//
+//   Portions created before 22-Nov-2008 00:00:00 GMT by LShift Ltd,
+//   Cohesive Financial Technologies LLC, or Rabbit Technologies Ltd
+//   are Copyright (C) 2007-2008 LShift Ltd, Cohesive Financial
+//   Technologies LLC, and Rabbit Technologies Ltd.
+//
+//   Portions created by LShift Ltd are Copyright (C) 2007-2010 LShift
+//   Ltd. Portions created by Cohesive Financial Technologies LLC are
+//   Copyright (C) 2007-2010 Cohesive Financial Technologies
+//   LLC. Portions created by Rabbit Technologies Ltd are Copyright
+//   (C) 2007-2010 Rabbit Technologies Ltd.
+//
+//   All Rights Reserved.
+//
+//   Contributor(s): ______________________________________.
+//
+//---------------------------------------------------------------------------
+
+using System;
+
+namespace RabbitMQ.Client.Events
+{
+
+    ///<summary>Delegate used to process flow control events.</summary>
+    public delegate void FlowControlEventHandler(IModel sender, FlowControlEventArgs args);
+
+    ///<summary>Event relating to flow control</summary>
+    public class FlowControlEventArgs : EventArgs
+    {
+        private readonly bool m_active;
+
+        public FlowControlEventArgs(bool active)
+        {
+            m_active = active;
+        }
+
+        ///<summary>Access the flow control setting</summary>
+        public bool Active { get { return m_active; } }
+    }
+}

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

@@ -82,6 +82,7 @@ public abstract class ModelBase : IFullModel
         private readonly object m_eventLock = new object();
         private BasicReturnEventHandler m_basicReturn;
         private CallbackExceptionEventHandler m_callbackException;
+        private FlowControlEventHandler m_flowControl;
         private BasicRecoverOkEventHandler m_basicRecoverOk;
 
         public ManualResetEvent m_flowControlBlock = new ManualResetEvent(true);
@@ -149,6 +150,24 @@ public event CallbackExceptionEventHandler CallbackException
             }
         }
 
+        public event FlowControlEventHandler FlowControl
+        {
+            add
+            {
+                lock (m_eventLock)
+                {
+                    m_flowControl += value;
+                }
+            }
+            remove
+            {
+                lock (m_eventLock)
+                {
+                    m_flowControl -= value;
+                }
+            }
+        }
+
         public event BasicRecoverOkEventHandler BasicRecoverOk
         {
             add
@@ -298,6 +317,31 @@ public virtual void OnCallbackException(CallbackExceptionEventArgs args)
             }
         }
 
+        public virtual void OnFlowControl(FlowControlEventArgs args)
+        {
+            FlowControlEventHandler handler;
+            lock (m_eventLock)
+            {
+                handler = m_flowControl;
+            }
+            if (handler != null)
+            {
+                foreach (FlowControlEventHandler h in handler.GetInvocationList())
+                {
+                    try
+                    {
+                        h(this, args);
+                    }
+                    catch (Exception e)
+                    {
+                        CallbackExceptionEventArgs exnArgs = new CallbackExceptionEventArgs(e);
+                        exnArgs.Detail["context"] = "OnFlowControl";
+                        OnCallbackException(exnArgs);
+                    }
+                }
+            }
+        }
+
         public virtual void OnBasicRecoverOk(EventArgs args)
         {
             BasicRecoverOkEventHandler handler;
@@ -455,6 +499,7 @@ public void HandleChannelFlow(bool active)
             else
                 m_flowControlBlock.Reset();
             _Private_ChannelFlowOk(active);
+            OnFlowControl(new FlowControlEventArgs(active));
         }
 
         public void HandleConnectionStart(byte versionMajor,