mcs/class/RabbitMQ.Client/src/client/exceptions/OperationInterruptedException.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, 2008 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 by LShift Ltd., Cohesive Financial Technologies
  42 //   LLC., and Rabbit Technologies Ltd. are Copyright (C) 2007, 2008
  43 //   LShift Ltd., Cohesive Financial Technologies LLC., and Rabbit
  44 //   Technologies Ltd.;
  45 //
  46 //   All Rights Reserved.
  47 //
  48 //   Contributor(s): ______________________________________.
  49 //
  50 //---------------------------------------------------------------------------
  51 using System;
  52 using System.Runtime.Serialization;
  53
  54 namespace RabbitMQ.Client.Exceptions
  55 {
  56     /// <summary>
  57     /// Thrown when a session is destroyed during an RPC call to a
  58     /// broker. For example, if a TCP connection dropping causes the
  59     /// destruction of a session in the middle of a QueueDeclare
  60     /// operation, an OperationInterruptedException will be thrown to
  61     /// the caller of IModel.QueueDeclare.
  62     /// </summary>
  63     [Serializable]
  64     public class OperationInterruptedException
  65         // Eventually, as part of .NET 3.0, we get to inherit from ...
  66         /* : OperationCanceledException */
  67         // Until then, there's sadly nothing better to inherit from than ...
  68         : Exception
  69     {
  70         ///<summary>Possible explanation for the interruption. May be null.</summary>
  71         protected ShutdownEventArgs shutdownReason;
  72
  73         protected OperationInterruptedException() { }
  74
  75         protected OperationInterruptedException(string message) : base(message) { }
  76
  77         protected OperationInterruptedException(string message, System.Exception inner)
  78             : base(message, inner) { }
  79
  80         protected OperationInterruptedException(SerializationInfo info,
  81                                                 StreamingContext context)
  82             : base(info, context) { }
  83
  84         ///<summary>Construct an OperationInterruptedException with
  85         ///the passed-in explanation, if any.</summary>
  86         public OperationInterruptedException(ShutdownEventArgs reason)
  87             : base(reason == null ? "The AMQP operation was interrupted" :
  88                    string.Format("The AMQP operation was interrupted: {0}",
  89                                  reason))
  90         {
  91             this.shutdownReason = reason;
  92         }
  93
  94         ///<summary>Retrieves the explanation for the shutdown. May
  95         ///return null if no explanation is available.</summary>
  96         public ShutdownEventArgs ShutdownReason { get { return shutdownReason; } }
  97     }
  98 }