1 // This source code is dual-licensed under the Apache License, version
2 // 2.0, and the Mozilla Public License, version 1.1.
6 //---------------------------------------------------------------------------
7 // Copyright (C) 2007, 2008 LShift Ltd., Cohesive Financial
8 // Technologies LLC., and Rabbit Technologies Ltd.
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
14 // http://www.apache.org/licenses/LICENSE-2.0
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 //---------------------------------------------------------------------------
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
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
36 // The Original Code is The RabbitMQ .NET Client.
38 // The Initial Developers of the Original Code are LShift Ltd.,
39 // Cohesive Financial Technologies LLC., and Rabbit Technologies Ltd.
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
46 // All Rights Reserved.
48 // Contributor(s): ______________________________________.
50 //---------------------------------------------------------------------------
51 using RabbitMQ.Client.Impl;
53 namespace RabbitMQ.Client
55 ///<summary>Object describing various overarching parameters
56 ///associated with a particular AMQP protocol variant.</summary>
57 public interface IProtocol
59 ///<summary>Retrieve the protocol's major version number</summary>
60 int MajorVersion { get; }
61 ///<summary>Retrieve the protocol's minor version number</summary>
62 int MinorVersion { get; }
63 ///<summary>Retrieve the protocol's API name, used for
64 ///printing, configuration properties, IDE integration,
65 ///Protocols.cs etc.</summary>
66 string ApiName { get; }
67 ///<summary>Retrieve the protocol's default TCP port</summary>
68 int DefaultPort { get; }
70 ///<summary>Returns false if this protocol variant defaults to
71 ///permitting Access.Requests to be sent to the peer, or true
72 ///if Access.Requests should be suppressed by
74 bool DefaultSuppressAccessRequest { get; }
76 ///<summary>Construct a frame handler for a given endpoint.</summary>
77 IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint);
78 ///<summary>Construct a connection from a given set of
79 ///parameters and a frame handler. The "insist" parameter is
80 ///passed on to the AMQP connection.open method.</summary>
81 IConnection CreateConnection(ConnectionParameters parameters,
83 IFrameHandler frameHandler);
84 ///<summary>Construct a protocol model atop a given session.</summary>
85 IModel CreateModel(ISession session);