mcs/class/RabbitMQ.Client/src/client/api/IBasicProperties.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-2010 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-2010 LShift
  47 //   Ltd. Portions created by Cohesive Financial Technologies LLC are
  48 //   Copyright (C) 2007-2010 Cohesive Financial Technologies
  49 //   LLC. Portions created by Rabbit Technologies Ltd are Copyright
  50 //   (C) 2007-2010 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 Basic 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.CreateBasicProperties().
  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 IBasicProperties : 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> non-persistent (1) or persistent (2) </summary>
  91         byte DeliveryMode { get; set; }
  92
  93         ///<summary> message priority, 0 to 9 </summary>
  94         byte Priority { get; set; }
  95
  96         ///<summary> application correlation identifier </summary>
  97         string CorrelationId { get; set; }
  98
  99         ///<summary> destination to reply to </summary>
 100         string ReplyTo { get; set; }
 101
 102         ///<summary> message expiration specification </summary>
 103         string Expiration { get; set; }
 104
 105         ///<summary> application message identifier </summary>
 106         string MessageId { get; set; }
 107
 108         ///<summary> message timestamp </summary>
 109         AmqpTimestamp Timestamp { get; set; }
 110
 111         ///<summary> message type name </summary>
 112         string Type { get; set; }
 113
 114         ///<summary> creating user id </summary>
 115         string UserId { get; set; }
 116
 117         ///<summary> creating application id </summary>
 118         string AppId { get; set; }
 119
 120         ///<summary> intra-cluster routing identifier </summary>
 121         string ClusterId { get; set; }
 122
 123         ///<summary> Clear the ContentType property. </summary>
 124         void ClearContentType();
 125
 126         ///<summary> Clear the ContentEncoding property. </summary>
 127         void ClearContentEncoding();
 128
 129         ///<summary> Clear the Headers property. </summary>
 130         void ClearHeaders();
 131
 132         ///<summary> Clear the DeliveryMode property. </summary>
 133         void ClearDeliveryMode();
 134
 135         ///<summary> Clear the Priority property. </summary>
 136         void ClearPriority();
 137
 138         ///<summary> Clear the CorrelationId property. </summary>
 139         void ClearCorrelationId();
 140
 141         ///<summary> Clear the ReplyTo property. </summary>
 142         void ClearReplyTo();
 143
 144         ///<summary> Clear the Expiration property. </summary>
 145         void ClearExpiration();
 146
 147         ///<summary> Clear the MessageId property. </summary>
 148         void ClearMessageId();
 149
 150         ///<summary> Clear the Timestamp property. </summary>
 151         void ClearTimestamp();
 152
 153         ///<summary> Clear the Type property. </summary>
 154         void ClearType();
 155
 156         ///<summary> Clear the UserId property. </summary>
 157         void ClearUserId();
 158
 159         ///<summary> Clear the AppId property. </summary>
 160         void ClearAppId();
 161
 162         ///<summary> Clear the ClusterId property. </summary>
 163         void ClearClusterId();
 164
 165         ///<summary> Returns true iff the ContentType property is present. </summary>
 166         bool IsContentTypePresent();
 167
 168         ///<summary> Returns true iff the ContentEncoding property is present. </summary>
 169         bool IsContentEncodingPresent();
 170
 171         ///<summary> Returns true iff the Headers property is present. </summary>
 172         bool IsHeadersPresent();
 173
 174         ///<summary> Returns true iff the DeliveryMode property is present. </summary>
 175         bool IsDeliveryModePresent();
 176
 177         ///<summary> Returns true iff the Priority property is present. </summary>
 178         bool IsPriorityPresent();
 179
 180         ///<summary> Returns true iff the CorrelationId property is present. </summary>
 181         bool IsCorrelationIdPresent();
 182
 183         ///<summary> Returns true iff the ReplyTo property is present. </summary>
 184         bool IsReplyToPresent();
 185
 186         ///<summary> Returns true iff the Expiration property is present. </summary>
 187         bool IsExpirationPresent();
 188
 189         ///<summary> Returns true iff the MessageId property is present. </summary>
 190         bool IsMessageIdPresent();
 191
 192         ///<summary> Returns true iff the Timestamp property is present. </summary>
 193         bool IsTimestampPresent();
 194
 195         ///<summary> Returns true iff the Type property is present. </summary>
 196         bool IsTypePresent();
 197
 198         ///<summary> Returns true iff the UserId property is present. </summary>
 199         bool IsUserIdPresent();
 200
 201         ///<summary> Returns true iff the AppId property is present. </summary>
 202         bool IsAppIdPresent();
 203
 204         ///<summary> Returns true iff the ClusterId property is present. </summary>
 205         bool IsClusterIdPresent();
 206
 207         ///<summary>Convenience property; parses ReplyTo property
 208         ///using PublicationAddress.Parse, and serializes it using
 209         ///PublicationAddress.ToString. Returns null if ReplyTo property
 210         ///cannot be parsed by PublicationAddress.Parse.</summary>
 211         PublicationAddress ReplyToAddress { get; set; }
 212
 213         ///<summary>Sets DeliveryMode to either persistent (2) or non-persistent (1).</summary>
 214         ///<remarks>
 215         ///<para>
 216         ///The numbers 1 and 2 for delivery mode are "magic" in that
 217         ///they appear in the AMQP 0-8 and 0-9 specifications as part
 218         ///of the definition of the DeliveryMode Basic-class property,
 219         ///without being defined as named constants.
 220         ///</para>
 221         ///<para>
 222         ///Calling this method causes DeliveryMode to take on a
 223         ///value. In order to reset DeliveryMode to the default empty
 224         ///condition, call ClearDeliveryMode.
 225         ///</para>
 226         ///</remarks>
 227         void SetPersistent(bool persistent);
 228     }
 229 }