mcs/class/RabbitMQ.Client/src/client/api/IMethod.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 namespace RabbitMQ.Client
  52 {
  53     ///<summary>A decoded AMQP method frame.</summary>
  54     ///<remarks>
  55     ///<para>
  56     /// AMQP methods can be RPC requests, RPC responses, exceptions
  57     /// (ChannelClose, ConnectionClose), or one-way asynchronous
  58     /// messages. Currently this information is not recorded in their
  59     /// type or interface: it is implicit in the way the method is
  60     /// used, and the way it is defined in the AMQP specification. A
  61     /// future revision of the RabbitMQ .NET client library may extend
  62     /// the IMethod interface to represent this information
  63     /// explicitly.
  64     ///</para>
  65     ///</remarks>
  66     public interface IMethod
  67     {
  68         /// <summary>
  69         /// Retrieves the class ID number of this method, as defined in the AMQP specification XML.
  70         /// </summary>
  71         int ProtocolClassId { get; }
  72
  73         /// <summary>
  74         /// Retrieves the method ID number of this method, as defined in the AMQP specification XML.
  75         /// </summary>
  76         int ProtocolMethodId { get; }
  77
  78         /// <summary>
  79         /// Retrieves the name of this method - for debugging use.
  80         /// </summary>
  81         string ProtocolMethodName { get; }
  82     }
  83 }