flatten Parameters into ConnectionFactory

David R. MacIver · David R. MacIver · commit 0412a6343d67 · 2009-12-22T16:38:28.000Z
diff --git a/projects/client/RabbitMQ.Client/src/client/api/ConnectionFactory.cs b/projects/client/RabbitMQ.Client/src/client/api/ConnectionFactory.cs
@@ -75,9 +75,9 @@ namespace RabbitMQ.Client
     ///     ConnectionFactory factory = new ConnectionFactory();
     ///     //
     ///     // The next three lines are optional:
-    ///     factory.Parameters.UserName = ConnectionParameters.DefaultUser;
-    ///     factory.Parameters.Password = ConnectionParameters.DefaultPass;
-    ///     factory.Parameters.VirtualHost = ConnectionParameters.DefaultVHost;
+    ///     factory.Parameters.UserName = ConnectionFactory.DefaultUser;
+    ///     factory.Parameters.Password = ConnectionFactory.DefaultPass;
+    ///     factory.Parameters.VirtualHost = ConnectionFactory.DefaultVHost;
     ///     //
     ///     IProtocol protocol = Protocols.DefaultProtocol;
     ///     IConnection conn = factory.CreateConnection(protocol, hostName, portNumber);
@@ -103,21 +103,86 @@ namespace RabbitMQ.Client
     ///</remarks>
     public class ConnectionFactory
     {
-        private ConnectionParameters m_parameters = new ConnectionParameters();
-        ///<summary>Retrieve the parameters this factory uses to
-        ///construct IConnection instances.</summary>
-        public ConnectionParameters Parameters
+        /// <summary>Default user name (value: "guest")</summary>
+        public const string DefaultUser = "guest"; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
+
+        /// <summary>Default password (value: "guest")</summary>
+        public const string DefaultPass = "guest"; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
+
+        /// <summary>Default virtual host (value: "/")</summary>
+        public const string DefaultVHost = "/"; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
+
+        /// <summary> Default value for the desired maximum channel
+        /// number, with zero meaning unlimited (value: 0)</summary>
+        public const ushort DefaultChannelMax = 0; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
+
+        /// <summary>Default value for the desired maximum frame size,
+        /// with zero meaning unlimited (value: 0)</summary>
+        public const uint DefaultFrameMax = 0; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
+
+        /// <summary>Default value for desired heartbeat interval, in
+        /// seconds, with zero meaning none (value: 0)</summary>
+        public const ushort DefaultHeartbeat = 0; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
+
+        private string m_userName = DefaultUser;
+        private string m_password = DefaultPass;
+        private string m_virtualHost = DefaultVHost;
+        private ushort m_requestedChannelMax = DefaultChannelMax;
+        private uint m_requestedFrameMax = DefaultFrameMax;
+        private ushort m_requestedHeartbeat = DefaultHeartbeat;
+        private SslOption m_ssl = new SslOption();
+
+        ///<summary>Construct a fresh instance, with all fields set to
+        ///their respective defaults.</summary>
+        public ConnectionFactory() { }
+
+        /// <summary>Username to use when authenticating to the server</summary>
+        public string UserName
         {
-            get
-            {
-                return m_parameters;
-            }
+            get { return m_userName; }
+            set { m_userName = value; }
+        }
+
+        /// <summary>Password to use when authenticating to the server</summary>
+        public string Password
+        {
+            get { return m_password; }
+            set { m_password = value; }
+        }
+
+        /// <summary>Virtual host to access during this connection</summary>
+        public string VirtualHost
+        {
+            get { return m_virtualHost; }
+            set { m_virtualHost = value; }
+        }
+
+        /// <summary>Maximum channel number to ask for</summary>
+        public ushort RequestedChannelMax
+        {
+            get { return m_requestedChannelMax; }
+            set { m_requestedChannelMax = value; }
+        }
+
+        /// <summary>Frame-max parameter to ask for (in bytes)</summary>
+        public uint RequestedFrameMax
+        {
+            get { return m_requestedFrameMax; }
+            set { m_requestedFrameMax = value; }
+        }
+
+        /// <summary>Heartbeat setting to request (in seconds)</summary>
+        public ushort RequestedHeartbeat
+        {
+            get { return m_requestedHeartbeat; }
+            set { m_requestedHeartbeat = value; }
         }
 
-        ///<summary>Constructs a ConnectionFactory with default values
-        ///for Parameters.</summary>
-        public ConnectionFactory()
+        ///<summary>Ssl options setting</summary>
+        public SslOption Ssl
         {
+            get { return m_ssl; }
+            set { m_ssl = value; }
         }
 
         protected virtual IConnection FollowRedirectChain
@@ -144,7 +209,7 @@ protected virtual IConnection FollowRedirectChain
                         // and fully open a successful connection,
                         // in which case we're done, and the
                         // connection should be returned.
-                        return p.CreateConnection(m_parameters, insist, fh);
+                        return p.CreateConnection(this, insist, fh);
                     } catch (RedirectException re) {
                         if (insist) {
                             // We've been redirected, but we insisted that
@@ -262,7 +327,7 @@ public IConnection CreateConnection(IProtocol version,
             return CreateConnection(new AmqpTcpEndpoint(version,
                                                         hostName,
                                                         portNumber,
-                                                        m_parameters.Ssl));
+                                                        this.Ssl));
         }
 
         ///<summary>Create a connection to the endpoint specified. The
diff --git a/projects/client/RabbitMQ.Client/src/client/api/IConnection.cs b/projects/client/RabbitMQ.Client/src/client/api/IConnection.cs
@@ -105,7 +105,7 @@ public interface IConnection: IDisposable
 
         ///<summary>The connection parameters used during construction
         ///of this connection.</summary>
-        ConnectionParameters Parameters { get; }
+        ConnectionFactory Parameters { get; }
 
         ///<summary>The maximum channel number this connection
         ///supports (0 if unlimited). Usable channel numbers
diff --git a/projects/client/RabbitMQ.Client/src/client/api/IProtocol.cs b/projects/client/RabbitMQ.Client/src/client/api/IProtocol.cs
@@ -78,7 +78,7 @@ public interface IProtocol
         ///<summary>Construct a connection from a given set of
         ///parameters and a frame handler. The "insist" parameter is
         ///passed on to the AMQP connection.open method.</summary>
-        IConnection CreateConnection(ConnectionParameters parameters,
+        IConnection CreateConnection(ConnectionFactory parameters,
                                      bool insist,
                                      IFrameHandler frameHandler);
         ///<summary>Construct a protocol model atop a given session.</summary>
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/AbstractProtocolBase.cs b/projects/client/RabbitMQ.Client/src/client/impl/AbstractProtocolBase.cs
@@ -66,7 +66,7 @@ public abstract class AbstractProtocolBase: IProtocol {
         public abstract int DefaultPort { get; }
 
         public abstract IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint);
-        public abstract IConnection CreateConnection(ConnectionParameters parameters,
+        public abstract IConnection CreateConnection(ConnectionFactory parameters,
                                                      bool insist,
                                                      IFrameHandler frameHandler);
         public abstract IModel CreateModel(ISession session);
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/ConnectionBase.cs b/projects/client/RabbitMQ.Client/src/client/impl/ConnectionBase.cs
@@ -89,7 +89,7 @@ public abstract class ConnectionBase : IConnection
         ///(milliseconds)</summary>
         public static int ConnectionCloseTimeout = 10000;
 
-        public ConnectionParameters m_parameters;
+        public ConnectionFactory m_parameters;
         public IFrameHandler m_frameHandler;
         public uint m_frameMax = 0;
         public ushort m_heartbeat = 0;
@@ -119,7 +119,7 @@ public abstract class ConnectionBase : IConnection
         
         public IList m_shutdownReport = ArrayList.Synchronized(new ArrayList());
 
-        public ConnectionBase(ConnectionParameters parameters,
+        public ConnectionBase(ConnectionFactory parameters,
                               bool insist,
                               IFrameHandler frameHandler)
         {
@@ -214,7 +214,7 @@ public void WriteFrame(Frame f)
             m_heartbeatWrite.Set();
         }
 
-        public ConnectionParameters Parameters
+        public ConnectionFactory Parameters
         {
             get
             {
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/v0_8/Connection.cs b/projects/client/RabbitMQ.Client/src/client/impl/v0_8/Connection.cs
@@ -59,7 +59,7 @@
 
 namespace RabbitMQ.Client.Framing.Impl.v0_8 {
     public class Connection: ConnectionBase {
-        public Connection(ConnectionParameters parameters, bool insist, IFrameHandler frameHandler)
+        public Connection(ConnectionFactory parameters, bool insist, IFrameHandler frameHandler)
             : base(parameters, insist, frameHandler) {}
     }
 }
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/v0_8/ProtocolBase.cs b/projects/client/RabbitMQ.Client/src/client/impl/v0_8/ProtocolBase.cs
@@ -69,7 +69,7 @@ public override IModel CreateModel(ISession session) {
             return new Model(session);
         }
 
-        public override IConnection CreateConnection(ConnectionParameters parameters,
+        public override IConnection CreateConnection(ConnectionFactory parameters,
                                                      bool insist,
                                                      IFrameHandler frameHandler)
         {
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/v0_8qpid/Connection.cs b/projects/client/RabbitMQ.Client/src/client/impl/v0_8qpid/Connection.cs
@@ -59,7 +59,7 @@
 
 namespace RabbitMQ.Client.Framing.Impl.v0_8qpid {
     public class Connection: ConnectionBase {
-        public Connection(ConnectionParameters parameters, bool insist, IFrameHandler frameHandler)
+        public Connection(ConnectionFactory parameters, bool insist, IFrameHandler frameHandler)
             : base(parameters, insist, frameHandler) {}
     }
 }
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/v0_8qpid/ProtocolBase.cs b/projects/client/RabbitMQ.Client/src/client/impl/v0_8qpid/ProtocolBase.cs
@@ -69,7 +69,7 @@ public override IModel CreateModel(ISession session) {
             return new Model(session);
         }
 
-        public override IConnection CreateConnection(ConnectionParameters parameters,
+        public override IConnection CreateConnection(ConnectionFactory parameters,
                                                      bool insist,
                                                      IFrameHandler frameHandler)
         {
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/v0_9/Connection.cs b/projects/client/RabbitMQ.Client/src/client/impl/v0_9/Connection.cs
@@ -59,7 +59,7 @@
 
 namespace RabbitMQ.Client.Framing.Impl.v0_9 {
     public class Connection: ConnectionBase {
-        public Connection(ConnectionParameters parameters, bool insist, IFrameHandler frameHandler)
+        public Connection(ConnectionFactory parameters, bool insist, IFrameHandler frameHandler)
             : base(parameters, insist, frameHandler) {}
     }
 }
diff --git a/projects/client/RabbitMQ.Client/src/client/impl/v0_9/ProtocolBase.cs b/projects/client/RabbitMQ.Client/src/client/impl/v0_9/ProtocolBase.cs
@@ -69,7 +69,7 @@ public override IModel CreateModel(ISession session) {
             return new Model(session);
         }
 
-        public override IConnection CreateConnection(ConnectionParameters parameters,
+        public override IConnection CreateConnection(ConnectionFactory parameters,
                                                      bool insist,
                                                      IFrameHandler frameHandler)
         {

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ public abstract class ConnectionBase : IConnection`
`89`	`89`	`///(milliseconds)</summary>`
`90`	`90`	`public static int ConnectionCloseTimeout = 10000;`
`91`	`91`
`92`		`- public ConnectionParameters m_parameters;`
	`92`	`+ public ConnectionFactory m_parameters;`
`93`	`93`	`public IFrameHandler m_frameHandler;`
`94`	`94`	`public uint m_frameMax = 0;`
`95`	`95`	`public ushort m_heartbeat = 0;`
`@@ -119,7 +119,7 @@ public abstract class ConnectionBase : IConnection`
`119`	`119`
`120`	`120`	`public IList m_shutdownReport = ArrayList.Synchronized(new ArrayList());`
`121`	`121`
`122`		`- public ConnectionBase(ConnectionParameters parameters,`
	`122`	`+ public ConnectionBase(ConnectionFactory parameters,`
`123`	`123`	`bool insist,`
`124`	`124`	`IFrameHandler frameHandler)`
`125`	`125`	`{`
`@@ -214,7 +214,7 @@ public void WriteFrame(Frame f)`
`214`	`214`	`m_heartbeatWrite.Set();`
`215`	`215`	`}`
`216`	`216`
`217`		`- public ConnectionParameters Parameters`
	`217`	`+ public ConnectionFactory Parameters`
`218`	`218`	`{`
`219`	`219`	`get`
`220`	`220`	`{`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@`
`59`	`59`
`60`	`60`	`namespace RabbitMQ.Client.Framing.Impl.v0_8 {`
`61`	`61`	`public class Connection: ConnectionBase {`
`62`		`- public Connection(ConnectionParameters parameters, bool insist, IFrameHandler frameHandler)`
	`62`	`+ public Connection(ConnectionFactory parameters, bool insist, IFrameHandler frameHandler)`
`63`	`63`	`: base(parameters, insist, frameHandler) {}`
`64`	`64`	`}`
`65`	`65`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ public override IModel CreateModel(ISession session) {`
`69`	`69`	`return new Model(session);`
`70`	`70`	`}`
`71`	`71`
`72`		`- public override IConnection CreateConnection(ConnectionParameters parameters,`
	`72`	`+ public override IConnection CreateConnection(ConnectionFactory parameters,`
`73`	`73`	`bool insist,`
`74`	`74`	`IFrameHandler frameHandler)`
`75`	`75`	`{`