mcs/class/RabbitMQ.Client/src/client/api/BinaryTableValue.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 namespace RabbitMQ.Client
  58 {
  59     ///<summary>Wrapper for a byte[]. May appear as values read from
  60     ///and written to AMQP field tables.</summary>
  61     ///<remarks>
  62     ///<para>
  63     /// The sole reason for the existence of this class is to permit
  64     /// encoding of byte[] as 'x' in AMQP field tables, an extension
  65     /// to the specification that is part of the tentative JMS mapping
  66     /// implemented by QPid.
  67     ///</para>
  68     ///<para>
  69     /// Instances of this object may be found as values held in
  70     /// IDictionary instances returned from
  71     /// RabbitMQ.Client.Impl.WireFormatting.ReadTable, e.g. as part of
  72     /// IBasicProperties.Headers tables. Likewise, instances may be
  73     /// set as values in an IDictionary table to be encoded by
  74     /// RabbitMQ.Client.Impl.WireFormatting.WriteTable.
  75     ///</para>
  76     ///<para>
  77     /// When an instance of this class is encoded/decoded, the type
  78     /// tag 'x' is used in the on-the-wire representation. The AMQP
  79     /// standard type tag 'S' is decoded to a raw byte[], and a raw
  80     /// byte[] is encoded as 'S'. Instances of System.String are
  81     /// converted to a UTF-8 binary representation, and then encoded
  82     /// using tag 'S'. In order to force the use of tag 'x', instances
  83     /// of this class must be used.
  84     ///</para>
  85     ///</remarks>
  86     public class BinaryTableValue
  87     {
  88         private byte[] m_bytes = null;
  89
  90         ///<summary>The wrapped byte array, as decoded or as to be
  91         ///encoded.</summary>
  92         public byte[] Bytes {
  93             get { return m_bytes; }
  94             set { m_bytes = value; }
  95         }
  96
  97         ///<summary>Constructs an instance with null for its Bytes
  98         ///property.</summary>
  99         public BinaryTableValue()
 100             : this(null)
 101         {}
 102
 103         ///<summary>Constructs an instance with the passed-in value
 104         ///for its Bytes property.</summary>
 105         public BinaryTableValue(byte[] bytes)
 106         {
 107             m_bytes = bytes;
 108         }
 109     }
 110 }