mcs/class/RabbitMQ.Client/src/client/api/IFileProperties.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
  55 {
  56     ///<summary>Common AMQP File content-class headers interface,
  57     ///spanning the union of the functionality offered by versions
  58     ///0-8, 0-8qpid and 0-9 (without WIP) of AMQP.</summary>
  59     ///<remarks>
  60     ///<para>
  61     ///The specification code generator provides
  62     ///protocol-version-specific implementations of this interface. To
  63     ///obtain an implementation of this interface in a
  64     ///protocol-version-neutral way, use
  65     ///IModel.CreateFileProperties().
  66     ///</para>
  67     ///<para>
  68     ///Each property is readable, writable and clearable: a cleared
  69     ///property will not be transmitted over the wire. Properties on a
  70     ///fresh instance are clear by default.
  71     ///</para>
  72     ///</remarks>
  73     public interface IFileProperties : IContentHeader
  74     {
  75         /// <summary> MIME content type </summary>
  76         string ContentType { get; set; }
  77
  78         /// <summary> MIME content encoding </summary>
  79         string ContentEncoding { get; set; }
  80
  81         /// <summary> message header field table </summary>
  82         IDictionary Headers { get; set; }
  83
  84         /// <summary> message priority, 0 to 9 </summary>
  85         byte Priority { get; set; }
  86
  87         /// <summary> destination to reply to </summary>
  88         string ReplyTo { get; set; }
  89
  90         /// <summary> application message identifier </summary>
  91         string MessageId { get; set; }
  92
  93         /// <summary> message filename </summary>
  94         string Filename { get; set; }
  95
  96         /// <summary> message timestamp </summary>
  97         AmqpTimestamp Timestamp { get; set; }
  98
  99         /// <summary> intra-cluster routing identifier </summary>
 100         string ClusterId { get; set; }
 101
 102         ///<summary> Clear the ContentType property. </summary>
 103         void ClearContentType();
 104
 105         ///<summary> Clear the ContentEncoding property. </summary>
 106         void ClearContentEncoding();
 107
 108         ///<summary> Clear the Headers property. </summary>
 109         void ClearHeaders();
 110
 111         ///<summary> Clear the Priority property. </summary>
 112         void ClearPriority();
 113
 114         ///<summary> Clear the ReplyTo property. </summary>
 115         void ClearReplyTo();
 116
 117         ///<summary> Clear the MessageId property. </summary>
 118         void ClearMessageId();
 119
 120         ///<summary> Clear the Filename property. </summary>
 121         void ClearFilename();
 122
 123         ///<summary> Clear the Timestamp property. </summary>
 124         void ClearTimestamp();
 125
 126         ///<summary> Clear the ClusterId property. </summary>
 127         void ClearClusterId();
 128     }
 129 }