mcs/class/RabbitMQ.Client/src/client/content/IMessageReader.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.IO;
  59 using System.Collections;
  60
  61 namespace RabbitMQ.Client.Content {
  62     ///<summary>Interface for analyzing application messages.</summary>
  63     ///<remarks>
  64     /// Subinterfaces provide specialized data-reading methods. This
  65     /// base interface deals with the lowest common denominator:
  66     /// bytes, with no special encodings for higher-level objects.
  67     ///</remarks>
  68     public interface IMessageReader {
  69         ///<summary>Retrieves the content header properties of the
  70         ///message being read.</summary>
  71         IDictionary Headers { get; }
  72
  73         ///<summary>Retrieve the message body, as a byte array.</summary>
  74         byte[] BodyBytes { get; }
  75
  76         ///<summary>Retrieve the Stream being used to read from the message body.</summary>
  77         Stream BodyStream { get; }
  78
  79         ///<summary>Read a single byte from the body stream, without
  80         ///encoding or interpretation. Returns -1 for end-of-stream.</summary>
  81         int RawRead();
  82
  83         ///<summary>Read bytes from the body stream into a section of
  84         ///an existing byte array, without encoding or
  85         ///interpretation. Returns the number of bytes read from the
  86         ///body and written into the target array, which may be less
  87         ///than the number requested if the end-of-stream is
  88         ///reached.</summary>
  89         int RawRead(byte[] target, int offset, int length);
  90     }
  91 }