mcs/class/RabbitMQ.Client/src/client/content/IStreamMessageBuilder.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
  59 namespace RabbitMQ.Client.Content {
  60     ///<summary>Interface for constructing messages binary-compatible
  61     ///with QPid's "StreamMessage" wire encoding.</summary>
  62     public interface IStreamMessageBuilder: IMessageBuilder {
  63         ///<summary>Writes a bool value into the message body being assembled.</summary>
  64         IStreamMessageBuilder WriteBool(bool value);
  65
  66         ///<summary>Writes an int value into the message body being assembled.</summary>
  67         IStreamMessageBuilder WriteInt32(int value);
  68
  69         ///<summary>Writes a short value into the message body being assembled.</summary>
  70         IStreamMessageBuilder WriteInt16(short value);
  71
  72         ///<summary>Writes a byte value into the message body being assembled.</summary>
  73         IStreamMessageBuilder WriteByte(byte value);
  74
  75         ///<summary>Writes a char value into the message body being assembled.</summary>
  76         IStreamMessageBuilder WriteChar(char value);
  77
  78         ///<summary>Writes a long value into the message body being assembled.</summary>
  79         IStreamMessageBuilder WriteInt64(long value);
  80
  81         ///<summary>Writes a float value into the message body being assembled.</summary>
  82         IStreamMessageBuilder WriteSingle(float value);
  83
  84         ///<summary>Writes a double value into the message body being assembled.</summary>
  85         IStreamMessageBuilder WriteDouble(double value);
  86
  87         ///<summary>Writes a section of a byte array into the message body being assembled.</summary>
  88         IStreamMessageBuilder WriteBytes(byte[] source, int offset, int count);
  89
  90         ///<summary>Writes a byte array into the message body being assembled.</summary>
  91         IStreamMessageBuilder WriteBytes(byte[] source);
  92
  93         ///<summary>Writes a string value into the message body being assembled.</summary>
  94         IStreamMessageBuilder WriteString(string value);
  95
  96         ///<summary>Writes an object value into the message body being assembled.</summary>
  97         ///<remarks>
  98         /// The only permitted types are bool, int, short, byte, char,
  99         /// long, float, double, byte[] and string.
 100         ///</remarks>
 101         IStreamMessageBuilder WriteObject(object value);
 102
 103         ///<summary>Writes objects using WriteObject(), one after the
 104         ///other. No length indicator is written. See also
 105         ///IStreamMessageReader.ReadObjects().</summary>
 106         IStreamMessageBuilder WriteObjects(params object[] values);
 107     }
 108 }