2009-05-21 Michael Barker <mike@middlesoft.co.uk>
[mono.git] / mcs / class / RabbitMQ.Client / src / util / NetworkBinaryWriter.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.IO;
58 using System.Text;
59
60 namespace RabbitMQ.Util {
61     /// <summary>
62     /// Subclass of BinaryWriter that writes integers etc in correct network order.
63     /// </summary>
64     ///
65     /// <remarks>
66     /// <p>
67     /// Kludge to compensate for .NET's broken little-endian-only BinaryWriter.
68     /// </p><p>
69     /// See also NetworkBinaryReader.
70     /// </p>
71     /// </remarks>
72     public class NetworkBinaryWriter: BinaryWriter {
73         /// <summary>
74         /// Construct a NetworkBinaryWriter over the given input stream.
75         /// </summary>
76         public NetworkBinaryWriter(Stream output): base(output) {}
77
78         /// <summary>
79         /// Construct a NetworkBinaryWriter over the given input
80         /// stream, reading strings using the given encoding.
81         /// </summary>
82         public NetworkBinaryWriter(Stream output, Encoding encoding): base(output, encoding) {}
83
84         /// <summary>
85         /// Override BinaryWriter's method for network-order.
86         /// </summary>
87         public override void Write(short i) {
88             Write((byte) ((i & 0xFF00) >> 8));
89             Write((byte) (i & 0x00FF));
90         }
91
92         /// <summary>
93         /// Override BinaryWriter's method for network-order.
94         /// </summary>
95         public override void Write(ushort i) {
96             Write((byte) ((i & 0xFF00) >> 8));
97             Write((byte) (i & 0x00FF));
98         }
99
100         /// <summary>
101         /// Override BinaryWriter's method for network-order.
102         /// </summary>
103         public override void Write(int i) {
104             Write((byte) ((i & 0xFF000000) >> 24));
105             Write((byte) ((i & 0x00FF0000) >> 16));
106             Write((byte) ((i & 0x0000FF00) >> 8));
107             Write((byte) (i & 0x000000FF));
108         }
109
110         /// <summary>
111         /// Override BinaryWriter's method for network-order.
112         /// </summary>
113         public override void Write(uint i) {
114             Write((byte) ((i & 0xFF000000) >> 24));
115             Write((byte) ((i & 0x00FF0000) >> 16));
116             Write((byte) ((i & 0x0000FF00) >> 8));
117             Write((byte) (i & 0x000000FF));
118         }
119
120         /// <summary>
121         /// Override BinaryWriter's method for network-order.
122         /// </summary>
123         public override void Write(long i) {
124             uint i1 = (uint) (i >> 32);
125             uint i2 = (uint) i;
126             Write(i1);
127             Write(i2);
128         }
129
130         /// <summary>
131         /// Override BinaryWriter's method for network-order.
132         /// </summary>
133         public override void Write(ulong i) {
134             uint i1 = (uint) (i >> 32);
135             uint i2 = (uint) i;
136             Write(i1);
137             Write(i2);
138         }
139
140         /// <summary>
141         /// Override BinaryWriter's method for network-order.
142         /// </summary>
143         public override void Write(float f) {
144             BinaryWriter w = TemporaryBinaryWriter(4);
145             w.Write(f);
146             byte[] wrongBytes = TemporaryContents(w);
147             Write(wrongBytes[3]);
148             Write(wrongBytes[2]);
149             Write(wrongBytes[1]);
150             Write(wrongBytes[0]);
151         }
152
153         /// <summary>
154         /// Override BinaryWriter's method for network-order.
155         /// </summary>
156         public override void Write(double d) {
157             BinaryWriter w = TemporaryBinaryWriter(8);
158             w.Write(d);
159             byte[] wrongBytes = TemporaryContents(w);
160             Write(wrongBytes[7]);
161             Write(wrongBytes[6]);
162             Write(wrongBytes[5]);
163             Write(wrongBytes[4]);
164             Write(wrongBytes[3]);
165             Write(wrongBytes[2]);
166             Write(wrongBytes[1]);
167             Write(wrongBytes[0]);
168         }
169
170         ///<summary>Helper method for constructing a temporary
171         ///BinaryWriter streaming into a fresh MemoryStream
172         ///provisioned with the given initialSize.</summary>
173         public static BinaryWriter TemporaryBinaryWriter(int initialSize) {
174             return new BinaryWriter(new MemoryStream(initialSize));
175         }
176
177         ///<summary>Helper method for extracting the byte[] contents
178         ///of a BinaryWriter over a MemoryStream, such as constructed
179         ///by TemporaryBinaryWriter.</summary>
180         public static byte[] TemporaryContents(BinaryWriter w) {
181             return ((MemoryStream) w.BaseStream).ToArray();
182         }
183     }
184 }