Merge default in.

Author: Steve Powell

Makefile

@@ -34,7 +34,7 @@ ensure-deliverables: rabbit-vsn
 	file ${RELEASE_DIR}/${NAME_VSN}.msm
 
 ensure-prerequisites: rabbit-vsn
-	dpkg -L htmldoc plotutils transfig graphviz docbook-utils > /dev/null
+	[ -f "/etc/debian_version" ] && dpkg -L htmldoc plotutils transfig graphviz docbook-utils || true > /dev/null
 
 ensure-release-dir: rabbit-vsn
 	touch ${RELEASE_DIR}/

docs/wikipages/data.ApiOverview.txt

@@ -26,7 +26,6 @@ The core API interfaces and classes are
 
 Other useful interfaces and classes include:
 
- - [code ConnectionParameters]: configures a [code ConnectionFactory]
  - [code QueueingBasicConsumer]: receives messages delivered from the server
  - [code Protocols]: support class for choosing an AMQP protocol variant
 
@@ -117,7 +116,7 @@ of the shell environment variable scanned.)
 
 ** Connecting to a broker
 
-The following code connects to an AMQP broker:
+The following two code snippets connect to an AMQP broker:
 
 @code java
  ConnectionFactory factory = new ConnectionFactory();
@@ -129,6 +128,16 @@ The following code connects to an AMQP broker:
  factory.Port = AmqpTcpEndpoint.UseDefaultPort;
  IConnection conn = factory.CreateConnection();
 
+@code java
+ ConnectionFactory factory = new ConnectionFactory();
+ factory.Uri = "amqp://user:pass@hostName:port/vhost";
+ IConnection conn = factory.CreateConnection();
+
+Since the .NET client uses a stricter interpretation of the AMQP URI
+spec than the other clients, care must be taken when using URIs.  In
+particular, the host part must not be omitted and virtual hosts with
+empty names are not addressable.
+
 All factory properties have default values. The default value for a property will be used if the property remains unassigned prior to creating a connection:
  - username: [code "guest"]
  - password: [code "guest"]

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

@@ -41,9 +41,9 @@
 
 namespace RabbitMQ.Client
 {
-    /// A pluggable authentication mechanism.
+    ///<summary>A pluggable authentication mechanism.</summary>
     public interface AuthMechanism {
-        /// Handle one round of challenge-response
+        ///<summary>Handle one round of challenge-response</summary>
         byte[] handleChallenge(byte[] challenge, ConnectionFactory factory);
     }
-}
+}

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

@@ -42,10 +42,10 @@
 namespace RabbitMQ.Client
 {
     public interface AuthMechanismFactory {
-        /// Return a new authentication mechanism implementation
+        ///<summary>Return a new authentication mechanism implementation</summary>
         AuthMechanism GetInstance();
 
-        /// The name of the authentication mechanism, as negotiated on the wire
+        ///<summary>The name of the authentication mechanism, as negotiated on the wire</summary>
         string Name { get; }
     }
-}
+}

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

@@ -41,6 +41,7 @@
 using System;
 using System.IO;
 using System.Net;
+using System.Net.Security;
 using System.Net.Sockets;
 using System.Collections;
 
@@ -76,17 +77,24 @@ namespace RabbitMQ.Client
     ///     conn.Close(Constants.ReplySuccess, "Closing the connection");
     ///</code></example>
     ///<para>
-    /// Please see also the API overview and tutorial in the User Guide.
+    ///The same example, written more compactly with AMQP URIs:
     ///</para>
+    ///<example><code>
+    ///     ConnectionFactory factory = new ConnectionFactory();
+    ///     factory.Uri = "amqp://localhost";
+    ///     IConnection conn = factory.CreateConnection();
+    ///     ...
+    ///</code></example>
     ///<para>
-    /// Some of the static methods described below take, as a
-    /// convenience, a System.Uri instance representing an AMQP server
-    /// address. The use of Uri here is not standardised - Uri is
-    /// simply a convenient container for internet-address-like
-    /// components. In particular, the Uri "Scheme" property is
-    /// ignored: only the "Host" and "Port" properties are extracted.
+    /// Please see also the API overview and tutorial in the User Guide.
     ///</para>
-    ///</remarks>
+    ///<para>
+    ///Note that the Uri property takes a string representation of an
+    ///AMQP URI.  Omitted URI parts will take default values.  The
+    ///host part of the URI cannot be omitted and URIs of the form
+    ///"amqp://foo/" (note the trailling slash) also represent the
+    ///default virtual host.  The latter issue means that virtual
+    ///hosts with an empty name are not addressable. </para></remarks>
     public class ConnectionFactory
     {
         /// <summary>Default user name (value: "guest")</summary>
@@ -152,6 +160,7 @@ public class ConnectionFactory
         ///<summary>The AMQP protocol to be used</summary>
         public IProtocol Protocol = Protocols.FromEnvironment();
 
+        ///<summary>The AMQP connection target</summary>
         public AmqpTcpEndpoint Endpoint
         { 
           get
@@ -167,21 +176,16 @@ public AmqpTcpEndpoint Endpoint
           }
         }
 
-        public String Address
+        ///<summary>Set connection parameters using the amqp or amqps scheme</summary>
+        public Uri uri
         {
-          get
-          { 
-              String result = HostName;
-              if(Port != AmqpTcpEndpoint.UseDefaultPort)
-              {
-                  result += (":" + Port);
-              }
-              return result;
-          }
-          set
-          {
-              Endpoint = AmqpTcpEndpoint.Parse(Protocol, value);
-          }      
+          set { SetUri(value); }
+        }
+
+        ///<summary>Set connection parameters using the amqp or amqps scheme</summary>
+        public String Uri
+        {
+          set { SetUri(new Uri(value, UriKind.Absolute)); }
         }
 
         ///<summary>Construct a fresh instance, with all fields set to
@@ -332,5 +336,61 @@ public AuthMechanismFactory AuthMechanismFactory(string[] mechs) {
 
             return null;
         }
+
+
+        private void SetUri(Uri uri)
+        {
+            Endpoint = new AmqpTcpEndpoint();
+
+            if ("amqp".CompareTo(uri.Scheme.ToLower()) == 0) {
+                // nothing special to do
+            } else if ("amqps".CompareTo(uri.Scheme.ToLower()) == 0) {
+                Ssl.Enabled = true;
+                Ssl.AcceptablePolicyErrors =
+                    SslPolicyErrors.RemoteCertificateNameMismatch;
+                Port = AmqpTcpEndpoint.DefaultAmqpSslPort;
+            } else {
+                throw new ArgumentException("Wrong scheme in AMQP URI: " +
+                                            uri.Scheme);
+            }
+            string host = uri.Host;
+            if (!String.IsNullOrEmpty(host)) {
+                HostName = host;
+            }
+            Ssl.ServerName = HostName;
+
+            int port = uri.Port;
+            if (port != -1) {
+                Port = port;
+            }
+
+            string userInfo = uri.UserInfo;
+            if (!String.IsNullOrEmpty(userInfo)) {
+                string[] userPass = userInfo.Split(':');
+                if (userPass.Length > 2) {
+                    throw new ArgumentException("Bad user info in AMQP " +
+                                                "URI: " + userInfo);
+                }
+                UserName = UriDecode(userPass[0]);
+                if (userPass.Length == 2) {
+                    Password = UriDecode(userPass[1]);
+                }
+            }
+
+            /* C# automatically changes URIs into a canonical form
+               that has at least the path segment "/". */
+            if (uri.Segments.Length > 2) {
+                throw new ArgumentException("Multiple segments in " +
+                                            "path of AMQP URI: " +
+                                            String.Join(", ", uri.Segments));
+            } else if (uri.Segments.Length == 2) {
+                VirtualHost = UriDecode(uri.Segments[1]);
+            }
+        }
+
+        //<summary>Unescape a string, protecting '+'.</summary>
+        private string UriDecode(string uri) {
+            return System.Uri.UnescapeDataString(uri.Replace("+", "%2B"));
+        }
     }
 }

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

@@ -317,26 +317,28 @@ uint QueueDelete(string queue,
         [AmqpUnsupported("RabbitMQ.Client.Framing.v0_9")]
         void ConfirmSelect();
 
-        //<summary>Wait until all published messages have been confirmed.
-        //<remarks>
-        //Waits until all messages published since the last call have
-        //been either ack'd or nack'd by the broker.  Returns whether
-        //all the messages were ack'd (and none were nack'd). Note,
-        //when called on a non-Confirm channel, returns true
-        //immediately.
-        //</remarks>
+        ///<summary>Wait until all published messages have been confirmed.
+        ///</summary>
+        ///<remarks>
+        ///Waits until all messages published since the last call have
+        ///been either ack'd or nack'd by the broker.  Returns whether
+        ///all the messages were ack'd (and none were nack'd). Note,
+        ///when called on a non-Confirm channel, returns true
+        ///immediately.
+        ///</remarks>
         [AmqpMethodDoNotImplement(null)]
         [AmqpUnsupported("RabbitMQ.Client.Framing.v0_8qpid")]
         [AmqpUnsupported("RabbitMQ.Client.Framing.v0_8")]
         [AmqpUnsupported("RabbitMQ.Client.Framing.v0_9")]
         bool WaitForConfirms();
 
-        //<summary>Wait until all published messages have been confirmed.
-        //<remarks>
-        //Waits until all messages published since the last call have
-        //been ack'd by the broker.  If a nack is received, throws an
-        //OperationInterrupedException exception immediately.
-        //</remarks>
+        ///<summary>Wait until all published messages have been confirmed.
+        ///</summary>
+        ///<remarks>
+        ///Waits until all messages published since the last call have
+        ///been ack'd by the broker.  If a nack is received, throws an
+        ///OperationInterrupedException exception immediately.
+        ///</remarks>
         [AmqpMethodDoNotImplement(null)]
         [AmqpUnsupported("RabbitMQ.Client.Framing.v0_8qpid")]
         [AmqpUnsupported("RabbitMQ.Client.Framing.v0_8")]

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

@@ -70,7 +70,8 @@ public bool Multiple
             set { m_multiple = value; }
         }
 
-        //<summary>Clients should ignore this field.</summary>
+        ///<summary>Ignore</summary>
+        ///<remarks>Clients should ignore this field.</remarks>
         public bool Requeue
         {
             get { return m_requeue; }

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

@@ -69,11 +69,6 @@ public abstract class ConnectionBase : IConnection
         ///complete (milliseconds)</summary>
         public static int HandshakeTimeout = 10000;
 
-        ///<summary>Timeout used while waiting for a
-        ///connection.close-ok reply to a connection.close request
-        ///(milliseconds)</summary>
-        public static int ConnectionCloseTimeout = 10000;
-
         public ConnectionFactory m_factory;
         public IFrameHandler m_frameHandler;
         public uint m_frameMax = 0;
@@ -630,15 +625,14 @@ public void MainLoop()
                                                           "Unexpected Exception",
                                                           ex));
             }
-            
-            // If allowed for clean shutdown
-            // Run main loop for a limited amount of time (as defined
-            // by ConnectionCloseTimeout).
+
+            // If allowed for clean shutdown, run main loop until the
+            // connection closes.
             if (shutdownCleanly)
             {
                 ClosingLoop();
             }
-            
+
             FinishClose();
 
             m_appContinuation.Set();
@@ -742,16 +736,10 @@ public void ClosingLoop()
         {
             try
             {
-                m_frameHandler.Timeout = ConnectionCloseTimeout;
-                DateTime startTimeout = DateTime.Now;
+                m_frameHandler.Timeout = 0;
                 // Wait for response/socket closure or timeout
                 while (!m_closed)
                 {
-                    if ((DateTime.Now - startTimeout).TotalMilliseconds >= ConnectionCloseTimeout)
-                    {
-                        LogCloseError("Timeout, when waiting for server's response on close", null);
-                        break;
-                    }
                     MainLoopIteration();
                 }
             }

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

@@ -49,9 +49,12 @@ namespace RabbitMQ.Client.Impl
 {
     public class SocketFrameHandler_0_9 : IFrameHandler
     {
-        public const int WSAEWOULDBLOCK = 10035; 
+        public const int WSAEWOULDBLOCK = 10035;
         // ^^ System.Net.Sockets.SocketError doesn't exist in .NET 1.1
 
+        // Timeout in seconds to wait for a clean socket close.
+        public const int SOCKET_CLOSING_TIMEOUT = 1;
+
         public AmqpTcpEndpoint m_endpoint;
         public TcpClient m_socket;
         public NetworkBinaryReader m_reader;
@@ -147,6 +150,7 @@ public void WriteFrame(Frame frame)
 
         public void Close()
         {
+            m_socket.LingerState = new LingerOption(true, SOCKET_CLOSING_TIMEOUT);
             m_socket.Close();
         }
     }