mcs/class/RabbitMQ.Client/src/client/impl/AbstractProtocolBase.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 RabbitMQ.Client;
  58 using RabbitMQ.Client.Impl;
  59 using RabbitMQ.Util;
  60
  61 namespace RabbitMQ.Client.Impl {
  62     public abstract class AbstractProtocolBase: IProtocol {
  63         public abstract int MajorVersion { get; }
  64         public abstract int MinorVersion { get; }
  65         public abstract string ApiName { get; }
  66         public abstract int DefaultPort { get; }
  67
  68         public abstract IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint);
  69         public abstract IConnection CreateConnection(ConnectionParameters parameters,
  70                                                      bool insist,
  71                                                      IFrameHandler frameHandler);
  72         public abstract IModel CreateModel(ISession session);
  73
  74         public abstract MethodBase DecodeMethodFrom(NetworkBinaryReader reader);
  75         public abstract ContentHeaderBase DecodeContentHeaderFrom(NetworkBinaryReader reader);
  76
  77         ///<summary>Used when a connection is being quiesced because
  78         ///of a HardProtocolException or Application initiated shutdown</summary>
  79         public abstract void CreateConnectionClose(ushort reasonCode,
  80                                                    string reasonText,
  81                                                    out Command request,
  82                                                    out int replyClassId,
  83                                                    out int replyMethodId);
  84
  85         ///<summary>Used when a channel is being quiesced because of a
  86         ///SoftProtocolException.</summary>
  87         public abstract void CreateChannelClose(ushort reasonCode,
  88                                                    string reasonText,
  89                                                    out Command request,
  90                                                    out int replyClassId,
  91                                                    out int replyMethodId);
  92
  93         ///<summary>Used in the quiescing session to determine if the command
  94         ///is allowed to be sent.</summary>
  95         public abstract bool CanSendWhileClosed(Command cmd);
  96
  97         public AmqpVersion Version {
  98             get {
  99                 return new AmqpVersion(MajorVersion, MinorVersion);
 100             }
 101         }
 102
 103             public override string ToString() {
 104                 return Version.ToString();
 105             }
 106
 107         public override bool Equals(object obj) {
 108             return (GetType() == obj.GetType());
 109         }
 110
 111         public override int GetHashCode() {
 112             return GetType().GetHashCode();
 113         }
 114     }
 115 }