mcs/class/RabbitMQ.Client/src/client/events/CallbackExceptionEventArgs.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.Collections;
  53
  54 namespace RabbitMQ.Client.Events
  55 {
  56     ///<summary>Describes an exception that was thrown during the
  57     ///library's invocation of an application-supplied callback
  58     ///handler.</summary>
  59     ///<remarks>
  60     ///<para>
  61     /// When an exception is thrown from a callback registered with
  62     /// part of the RabbitMQ .NET client library, it is caught,
  63     /// packaged into a CallbackExceptionEventArgs, and passed through
  64     /// the appropriate IModel's or IConnection's CallbackException
  65     /// event handlers. If an exception is thrown in a
  66     /// CallbackException handler, it is silently swallowed, as
  67     /// CallbackException is the last chance to handle these kinds of
  68     /// exception.
  69     ///</para>
  70     ///<para>
  71     /// Code constructing CallbackExceptionEventArgs instances will
  72     /// usually place helpful information about the context of the
  73     /// call in the IDictionary available through the Detail property.
  74     ///</para>
  75     ///</remarks>
  76     public class CallbackExceptionEventArgs: EventArgs
  77     {
  78         private IDictionary m_detail;
  79         private Exception m_exception;
  80
  81         ///<summary>Wrap an exception thrown by a callback.</summary>
  82         public CallbackExceptionEventArgs(Exception exception)
  83         {
  84             m_detail = new Hashtable();
  85             m_exception = exception;
  86         }
  87
  88         ///<summary>Access helpful information about the context in
  89         ///which the wrapped exception was thrown.</summary>
  90         public IDictionary Detail { get { return m_detail; } }
  91
  92         ///<summary>Access the wrapped exception.</summary>
  93         public Exception Exception { get { return m_exception; } }
  94     }
  95 }