mcs/class/RabbitMQ.Client/src/client/api/AmqpVersion.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>Represents a version of the AMQP specification.</summary>
  62     ///<remarks>
  63     ///<para>
  64     ///Vendor-specific variants of particular official specification
  65     ///versions exist: this class simply represents the AMQP
  66     ///specification version, and does not try to represent
  67     ///information about any custom variations involved.
  68     ///</para>
  69     ///<para>
  70     ///AMQP version 0-8 peers sometimes advertise themselves as
  71     ///version 8-0: for this reason, this class's constructor
  72     ///special-cases 8-0, rewriting it at construction time to be 0-8
  73     ///instead.
  74     ///</para>
  75     ///</remarks>
  76     public class AmqpVersion
  77     {
  78         private readonly int m_major;
  79         private readonly int m_minor;
  80
  81         ///<summary>The AMQP specification major version number</summary>
  82         public int Major { get { return m_major; } }
  83         ///<summary>The AMQP specification minor version number</summary>
  84         public int Minor { get { return m_minor; } }
  85
  86         ///<summary>Construct an AmqpVersion from major and minor version numbers.</summary>
  87         ///<remarks>
  88         ///Converts major=8 and minor=0 into major=0 and
  89         ///minor=8. Please see the class comment.
  90         ///</remarks>
  91         public AmqpVersion(int major, int minor)
  92         {
  93             if (major == 8 && minor == 0)
  94             {
  95                 // The AMQP 0-8 spec confusingly defines the version
  96                 // as 8-0. This maps the latter to the former, for
  97                 // cases where our peer might be confused.
  98                 major = 0;
  99                 minor = 8;
 100             }
 101             m_major = major;
 102             m_minor = minor;
 103         }
 104
 105         ///<summary>Format appropriately for display.</summary>
 106         ///<remarks>
 107         ///The specification currently uses "MAJOR-MINOR" as a display format.
 108         ///</remarks>
 109         public override string ToString()
 110         {
 111             return m_major + "-" + m_minor;
 112         }
 113
 114         ///<summary>Implement value-equality comparison.</summary>
 115         public override bool Equals(object other)
 116         {
 117             AmqpVersion v = other as AmqpVersion;
 118             return (v != null) && (v.m_major == m_major) && (v.m_minor == m_minor);
 119         }
 120
 121         ///<summary>Implement hashing as for value-equality.</summary>
 122         public override int GetHashCode()
 123         {
 124             return 31 * m_major.GetHashCode() + m_minor.GetHashCode();
 125         }
 126     }
 127 }