Introduce ConnectionFactory#UseBackgroundThreadsForIO

Make it possible to configure the client to use background
threads for I/O and heartbeat senders.

Author: michaelklishin

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

@@ -146,6 +146,8 @@ public class ConnectionFactory
         /// <summary>Timeout setting for connection attempts (in milliseconds)</summary>
         public int RequestedConnectionTimeout = DefaultConnectionTimeout;
 
+        public bool UseBackgroundThreadsForIO = false;
+
         /// <summary>Dictionary of client properties to be sent to the
         /// server</summary>
         public IDictionary<string, object> ClientProperties = ConnectionBase.DefaultClientProperties();

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

@@ -117,9 +117,9 @@ public ConnectionBase(ConnectionFactory factory,
             m_session0.Handler = new MainSession.SessionCloseDelegate(NotifyReceivedCloseOk);
             m_model0 = (ModelBase)Protocol.CreateModel(m_session0);
 
-            StartMainLoop();
+            StartMainLoop(factory.UseBackgroundThreadsForIO);
             Open(insist);
-            StartHeartbeatLoops();
+            StartHeartbeatLoops(factory.UseBackgroundThreadsForIO);
             AppDomain.CurrentDomain.DomainUnload += HandleDomainUnload;
         }
 
@@ -540,25 +540,27 @@ public void TerminateMainloop()
             m_running = false;
         }
 
-        public void StartMainLoop()
+        public void StartMainLoop(bool useBackgroundThread)
         {
             Thread mainLoopThread = new Thread(new ThreadStart(MainLoop));
             mainLoopThread.Name = "AMQP Connection " + Endpoint.ToString();
+            mainLoopThread.IsBackground = useBackgroundThread;
             mainLoopThread.Start();
         }
 
-        public void StartHeartbeatLoops()
+        public void StartHeartbeatLoops(bool useBackgroundThread)
         {
             if (Heartbeat != 0) {
-                StartHeartbeatLoop(new ThreadStart(HeartbeatReadLoop), "Inbound");
-                StartHeartbeatLoop(new ThreadStart(HeartbeatWriteLoop), "Outbound");
+                StartHeartbeatLoop(new ThreadStart(HeartbeatReadLoop), "Inbound", useBackgroundThread);
+                StartHeartbeatLoop(new ThreadStart(HeartbeatWriteLoop), "Outbound", useBackgroundThread);
             }
         }
 
-        public void StartHeartbeatLoop(ThreadStart loop, string name)
+        public void StartHeartbeatLoop(ThreadStart loop, string name, bool useBackgroundThread)
         {
             Thread heartbeatLoop = new Thread(loop);
             heartbeatLoop.Name = "AMQP Heartbeat " + name + " for Connection " + Endpoint.ToString();
+            heartbeatLoop.IsBackground = useBackgroundThread;
             heartbeatLoop.Start();
         }
 

projects/client/RabbitMQ.Client/src/client/impl/v0_9_1/ProtocolBase.cs

@@ -78,17 +78,17 @@ public IModel CreateModel(ISession session) {
         }
 
         public IConnection CreateConnection(ConnectionFactory factory,
-                                                     bool insist,
-                                                     IFrameHandler frameHandler)
+                                            bool insist,
+                                            IFrameHandler frameHandler)
         {
             return new Connection(factory, insist, frameHandler);
         }
 
         public void CreateConnectionClose(ushort reasonCode,
-                                                   string reasonText,
-                                                   out Command request,
-                                                   out int replyClassId,
-                                                   out int replyMethodId)
+                                          string reasonText,
+                                          out Command request,
+                                          out int replyClassId,
+                                          out int replyMethodId)
         {
             request = new Command(new RabbitMQ.Client.Framing.Impl.v0_9_1.ConnectionClose(reasonCode,
                                                                                           reasonText,

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

@@ -0,0 +1,77 @@
+// 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-2014 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) 2007-2014 GoPivotal, Inc.  All rights reserved.
+//---------------------------------------------------------------------------
+
+using NUnit.Framework;
+
+using System;
+using System.IO;
+using System.Text;
+using System.Collections;
+
+using RabbitMQ.Client;
+using RabbitMQ.Client.Impl;
+using RabbitMQ.Client.Exceptions;
+using RabbitMQ.Util;
+
+namespace RabbitMQ.Client.Unit
+{
+    [TestFixture]
+    public class TestConnectionWithBackgroundThreads
+    {
+
+        [Test]
+        public void TestWithBackgroundThreadsEnabled()
+        {
+            ConnectionFactory connFactory = new ConnectionFactory();
+            connFactory.UseBackgroundThreadsForIO = true;
+
+            IConnection conn = connFactory.CreateConnection();
+            IModel ch = conn.CreateModel();
+
+            // sanity check
+            string q = ch.QueueDeclare();
+            ch.QueueDelete(q);
+
+            ch.Close();
+            conn.Close();
+        }
+    }
+}
+