mcs/class/RabbitMQ.Client/src/client/api/IStreamProperties.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-2009 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-2009 LShift
  47 //   Ltd. Portions created by Cohesive Financial Technologies LLC are
  48 //   Copyright (C) 2007-2009 Cohesive Financial Technologies
  49 //   LLC. Portions created by Rabbit Technologies Ltd are Copyright
  50 //   (C) 2007-2009 Rabbit Technologies Ltd.
  51 //
  52 //   All Rights Reserved.
  53 //
  54 //   Contributor(s): ______________________________________.
  55 //
  56 //---------------------------------------------------------------------------
  57 using System;
  58 using System.Collections;
  59
  60 namespace RabbitMQ.Client
  61 {
  62     ///<summary>Common AMQP Stream content-class headers interface,
  63     ///spanning the union of the functionality offered by versions
  64     ///0-8, 0-8qpid and 0-9 (without WIP) of AMQP.</summary>
  65     ///<remarks>
  66     ///<para>
  67     ///The specification code generator provides
  68     ///protocol-version-specific implementations of this interface. To
  69     ///obtain an implementation of this interface in a
  70     ///protocol-version-neutral way, use
  71     ///IModel.CreateStreamProperties().
  72     ///</para>
  73     ///<para>
  74     ///Each property is readable, writable and clearable: a cleared
  75     ///property will not be transmitted over the wire. Properties on a
  76     ///fresh instance are clear by default.
  77     ///</para>
  78     ///</remarks>
  79     public interface IStreamProperties : IContentHeader
  80     {
  81         ///<summary> MIME content type </summary>
  82         string ContentType { get; set; }
  83
  84         ///<summary> MIME content encoding </summary>
  85         string ContentEncoding { get; set; }
  86
  87         ///<summary> message header field table </summary>
  88         IDictionary Headers { get; set; }
  89
  90         ///<summary> message priority, 0 to 9 </summary>
  91         byte Priority { get; set; }
  92
  93         ///<summary> message timestamp </summary>
  94         AmqpTimestamp Timestamp { get; set; }
  95
  96         ///<summary> Clear the ContentType property. </summary>
  97         void ClearContentType();
  98
  99         ///<summary> Clear the ContentEncoding property. </summary>
 100         void ClearContentEncoding();
 101
 102         ///<summary> Clear the Headers property. </summary>
 103         void ClearHeaders();
 104
 105         ///<summary> Clear the Priority property. </summary>
 106         void ClearPriority();
 107
 108         ///<summary> Clear the Timestamp property. </summary>
 109         void ClearTimestamp();
 110     }
 111 }