mcs/class/RabbitMQ.Client/src/client/api/ConnectionParameters.cs

   1 // This source code is dual-licensed under the Apache License, version
   2 // 2.0, and the Mozilla Public License, version 1.1.
   3 //
   4 // The APL v2.0:
   5 //
   6 //---------------------------------------------------------------------------
   7 //   Copyright (C) 2007-2009 LShift Ltd., Cohesive Financial
   8 //   Technologies LLC., and Rabbit Technologies Ltd.
   9 //
  10 //   Licensed under the Apache License, Version 2.0 (the "License");
  11 //   you may not use this file except in compliance with the License.
  12 //   You may obtain a copy of the License at
  13 //
  14 //       http://www.apache.org/licenses/LICENSE-2.0
  15 //
  16 //   Unless required by applicable law or agreed to in writing, software
  17 //   distributed under the License is distributed on an "AS IS" BASIS,
  18 //   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19 //   See the License for the specific language governing permissions and
  20 //   limitations under the License.
  21 //---------------------------------------------------------------------------
  22 //
  23 // The MPL v1.1:
  24 //
  25 //---------------------------------------------------------------------------
  26 //   The contents of this file are subject to the Mozilla Public License
  27 //   Version 1.1 (the "License"); you may not use this file except in
  28 //   compliance with the License. You may obtain a copy of the License at
  29 //   http://www.rabbitmq.com/mpl.html
  30 //
  31 //   Software distributed under the License is distributed on an "AS IS"
  32 //   basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
  33 //   License for the specific language governing rights and limitations
  34 //   under the License.
  35 //
  36 //   The Original Code is The RabbitMQ .NET Client.
  37 //
  38 //   The Initial Developers of the Original Code are LShift Ltd,
  39 //   Cohesive Financial Technologies LLC, and Rabbit Technologies Ltd.
  40 //
  41 //   Portions created before 22-Nov-2008 00:00:00 GMT by LShift Ltd,
  42 //   Cohesive Financial Technologies LLC, or Rabbit Technologies Ltd
  43 //   are Copyright (C) 2007-2008 LShift Ltd, Cohesive Financial
  44 //   Technologies LLC, and Rabbit Technologies Ltd.
  45 //
  46 //   Portions created by LShift Ltd are Copyright (C) 2007-2009 LShift
  47 //   Ltd. Portions created by Cohesive Financial Technologies LLC are
  48 //   Copyright (C) 2007-2009 Cohesive Financial Technologies
  49 //   LLC. Portions created by Rabbit Technologies Ltd are Copyright
  50 //   (C) 2007-2009 Rabbit Technologies Ltd.
  51 //
  52 //   All Rights Reserved.
  53 //
  54 //   Contributor(s): ______________________________________.
  55 //
  56 //---------------------------------------------------------------------------
  57 using System;
  58
  59 namespace RabbitMQ.Client
  60 {
  61     ///<summary>Supplies values to ConnectionFactory for use in
  62     ///constructing IConnection instances.</summary>
  63     public class ConnectionParameters : ICloneable
  64     {
  65         /// <summary>Default user name (value: "guest")</summary>
  66         public const string DefaultUser = "guest"; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
  67
  68         /// <summary>Default password (value: "guest")</summary>
  69         public const string DefaultPass = "guest"; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
  70
  71         /// <summary>Default virtual host (value: "/")</summary>
  72         public const string DefaultVHost = "/"; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
  73
  74         /// <summary> Default value for the desired maximum channel
  75         /// number, with zero meaning unlimited (value: 0)</summary>
  76         public const ushort DefaultChannelMax = 0; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
  77
  78         /// <summary>Default value for the desired maximum frame size,
  79         /// with zero meaning unlimited (value: 0)</summary>
  80         public const uint DefaultFrameMax = 0; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
  81
  82         /// <summary>Default value for desired heartbeat interval, in
  83         /// seconds, with zero meaning none (value: 3)</summary>
  84         public const ushort DefaultHeartbeat = 3; // PLEASE KEEP THIS MATCHING THE DOC ABOVE
  85
  86         private string m_userName = DefaultUser;
  87         private string m_password = DefaultPass;
  88         private string m_virtualHost = DefaultVHost;
  89         private ushort m_requestedChannelMax = DefaultChannelMax;
  90         private uint m_requestedFrameMax = DefaultFrameMax;
  91         private ushort m_requestedHeartbeat = DefaultHeartbeat;
  92
  93         ///<summary>Construct a fresh instance, with all fields set to
  94         ///their respective defaults.</summary>
  95         public ConnectionParameters() { }
  96
  97         /// <summary>Username to use when authenticating to the server</summary>
  98         public string UserName
  99         {
 100             get { return m_userName; }
 101             set { m_userName = value; }
 102         }
 103
 104         /// <summary>Password to use when authenticating to the server</summary>
 105         public string Password
 106         {
 107             get { return m_password; }
 108             set { m_password = value; }
 109         }
 110
 111         /// <summary>Virtual host to access during this connection</summary>
 112         public string VirtualHost
 113         {
 114             get { return m_virtualHost; }
 115             set { m_virtualHost = value; }
 116         }
 117
 118         /// <summary>Maximum channel number to ask for</summary>
 119         public ushort RequestedChannelMax
 120         {
 121             get { return m_requestedChannelMax; }
 122             set { m_requestedChannelMax = value; }
 123         }
 124
 125         /// <summary>Frame-max parameter to ask for (in bytes)</summary>
 126         public uint RequestedFrameMax
 127         {
 128             get { return m_requestedFrameMax; }
 129             set { m_requestedFrameMax = value; }
 130         }
 131
 132         /// <summary>Heartbeat setting to request (in seconds)</summary>
 133         public ushort RequestedHeartbeat
 134         {
 135             get { return m_requestedHeartbeat; }
 136             set { m_requestedHeartbeat = value; }
 137         }
 138
 139         ///<summary>Implement ICloneable.Clone by delegating to our type-safe variant.</summary>
 140         object ICloneable.Clone()
 141         {
 142             return ((ConnectionParameters)this).Clone();
 143         }
 144
 145         ///<summary>Returns a fresh ConnectionParameters with the same values as this.</summary>
 146         public ConnectionParameters Clone()
 147         {
 148             ConnectionParameters n = this.MemberwiseClone() as ConnectionParameters;
 149             return n;
 150         }
 151     }
 152 }