mcs/class/RabbitMQ.Client/src/client/exceptions/ChannelAllocationException.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-2010 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-2010 LShift
  47 //   Ltd. Portions created by Cohesive Financial Technologies LLC are
  48 //   Copyright (C) 2007-2010 Cohesive Financial Technologies
  49 //   LLC. Portions created by Rabbit Technologies Ltd are Copyright
  50 //   (C) 2007-2010 Rabbit Technologies Ltd.
  51 //
  52 //   All Rights Reserved.
  53 //
  54 //   Contributor(s): ______________________________________.
  55 //
  56 //---------------------------------------------------------------------------
  57 using System;
  58
  59 namespace RabbitMQ.Client.Exceptions
  60 {
  61     /// <summary> Thrown when a SessionManager cannot allocate a new
  62     /// channel number, or the requested channel number is already in
  63     /// use. </summary>
  64     public class ChannelAllocationException : Exception
  65     {
  66         private readonly int m_channel;
  67
  68         /// <summary>
  69         /// Indicates that there are no more free channels.
  70         /// </summary>
  71         public ChannelAllocationException()
  72             : base("The connection cannot support any more channels. Consider creating a new connection")
  73         {
  74             m_channel = -1;
  75         }
  76
  77         /// <summary>
  78         /// Indicates that the specified channel is in use
  79         /// </summary>
  80         /// <param name="channel">The requested channel number</param>
  81         public ChannelAllocationException(int channel)
  82             : base(string.Format("The Requested Channel ({0}) is already in use.", channel))
  83         {
  84             m_channel = channel;
  85         }
  86
  87         ///<summary>Retrieves the channel number concerned; will
  88         ///return -1 in the case where "no more free channels" is
  89         ///being signalled, or a non-negative integer when "channel is
  90         ///in use" is being signalled.</summary>
  91         public int Channel { get { return m_channel; } }
  92     }
  93 }