Add full C# NetworkMessage API

Source/Engine/Networking/NetworkMessage.cs

@@ -1,34 +1,387 @@
 // Copyright (c) 2012-2021 Wojciech Figat. All rights reserved.
 
 using System;
+using System.Text;
+using FlaxEngine.Assertions;
 
 namespace FlaxEngine.Networking
 {
     public unsafe partial struct NetworkMessage
     {
+        /// <summary>
+        /// Writes raw bytes into the message.
+        /// </summary>
+        /// <param name="bytes">The bytes that will be written.</param>
+        /// <param name="length">The amount of bytes to write from the <see cref="bytes"/> pointer.</param>
         public void WriteBytes(byte* bytes, int length)
         {
+            Assert.IsTrue(Position + length < BufferSize, $"Could not write data of length {length} into message with id={MessageId}!");
             Utils.MemoryCopy(new IntPtr(bytes), new IntPtr(Buffer + Position), length);
             Position += (uint)length;
             Length = Position;
         }
 
+        /// <summary>
+        /// Reads raw bytes from the message into the given byte array.
+        /// </summary>
+        /// <param name="buffer">
+        /// The buffer pointer that will be used to store the bytes.
+        /// Should be of the same length as <see cref="length"/> or longer.
+        /// </param>
+        /// <param name="length">The minimal amount of bytes that the <see cref="buffer"/> contains.</param>
         public void ReadBytes(byte* buffer, int length)
         {
+            Assert.IsTrue(Position + length < Length, $"Could not read data of length {length} from message with id={MessageId}!");
             Utils.MemoryCopy(new IntPtr(Buffer + Position), new IntPtr(buffer), length);
             Position += (uint)length;
         }
 
+        /// <summary>
+        /// Writes raw bytes into the message.
+        /// </summary>
+        /// <param name="bytes">The bytes that will be written.</param>
+        /// <param name="length">The amount of bytes to write from the <see cref="bytes"/> array.</param>
+        public void WriteBytes(byte[] bytes, int length)
+        {
+            fixed (byte* bytesPtr = bytes)
+            {
+                WriteBytes(bytesPtr, length);
+            }
+        }
+
+        /// <summary>
+        /// Reads raw bytes from the message into the given byte array.
+        /// </summary>
+        /// <param name="buffer">
+        /// The buffer that will be used to store the bytes.
+        /// Should be of the same length as <see cref="length"/> or longer.
+        /// </param>
+        /// <param name="length">The minimal amount of bytes that the <see cref="buffer"/> contains.</param>
+        public void ReadBytes(byte[] buffer, int length)
+        {
+            fixed (byte* bufferPtr = buffer)
+            {
+                ReadBytes(bufferPtr, length);
+            }
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="UInt64"/> into the message.
+        /// </summary>
+        public void WriteInt64(long value)
+        {
+            WriteBytes((byte*)&value, sizeof(long));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="UInt64"/> from the message.
+        /// </summary>
+        public long ReadInt64()
+        {
+            long value = 0;
+            ReadBytes((byte*)&value, sizeof(long));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="UInt32"/> into the message.
+        /// </summary>
+        public void WriteInt32(int value)
+        {
+            WriteBytes((byte*)&value, sizeof(int));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="UInt32"/> from the message.
+        /// </summary>
+        public int ReadInt32()
+        {
+            int value = 0;
+            ReadBytes((byte*)&value, sizeof(int));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="UInt16"/> into the message.
+        /// </summary>
+        public void WriteInt16(short value)
+        {
+            WriteBytes((byte*)&value, sizeof(short));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="UInt16"/> from the message.
+        /// </summary>
+        public short ReadInt16()
+        {
+            short value = 0;
+            ReadBytes((byte*)&value, sizeof(short));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="SByte"/> into the message.
+        /// </summary>
+        public void WriteSByte(sbyte value)
+        {
+            WriteBytes((byte*)&value, sizeof(sbyte));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="SByte"/> from the message.
+        /// </summary>
+        public sbyte ReadSByte()
+        {
+            sbyte value = 0;
+            ReadBytes((byte*)&value, sizeof(sbyte));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="UInt64"/> into the message.
+        /// </summary>
+        public void WriteUInt64(ulong value)
+        {
+            WriteBytes((byte*)&value, sizeof(ulong));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="UInt64"/> from the message.
+        /// </summary>
+        public ulong ReadUInt64()
+        {
+            ulong value = 0;
+            ReadBytes((byte*)&value, sizeof(ulong));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="UInt32"/> into the message.
+        /// </summary>
         public void WriteUInt32(uint value)
         {
             WriteBytes((byte*)&value, sizeof(uint));
         }
 
+        /// <summary>
+        /// Reads and returns data of type <see cref="UInt32"/> from the message.
+        /// </summary>
         public uint ReadUInt32()
         {
             uint value = 0;
             ReadBytes((byte*)&value, sizeof(uint));
             return value;
         }
+
+        /// <summary>
+        /// Writes data of type <see cref="UInt16"/> into the message.
+        /// </summary>
+        public void WriteUInt16(ushort value)
+        {
+            WriteBytes((byte*)&value, sizeof(ushort));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="UInt16"/> from the message.
+        /// </summary>
+        public ushort ReadUInt16()
+        {
+            ushort value = 0;
+            ReadBytes((byte*)&value, sizeof(ushort));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Byte"/> into the message.
+        /// </summary>
+        public void WriteByte(byte value)
+        {
+            WriteBytes(&value, sizeof(byte));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Byte"/> from the message.
+        /// </summary>
+        public byte ReadByte()
+        {
+            byte value = 0;
+            ReadBytes(&value, sizeof(byte));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Single"/> into the message.
+        /// </summary>
+        public void WriteSingle(float value)
+        {
+            WriteBytes((byte*)&value, sizeof(float));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Single"/> from the message.
+        /// </summary>
+        public float ReadSingle()
+        {
+            float value = 0.0f;
+            ReadBytes((byte*)&value, sizeof(float));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Double"/> into the message.
+        /// </summary>
+        public void WriteDouble(double value)
+        {
+            WriteBytes((byte*)&value, sizeof(double));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Double"/> from the message.
+        /// </summary>
+        public double ReadDouble()
+        {
+            double value = 0.0;
+            ReadBytes((byte*)&value, sizeof(double));
+            return value;
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="string"/> into the message. UTF-8 encoded.
+        /// </summary>
+        public void WriteString(string value)
+        {
+            var data = Encoding.UTF8.GetBytes(value);
+            WriteUInt16((ushort)data.Length);
+            WriteBytes(data, data.Length);
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="string"/> from the message. UTF-8 encoded.
+        /// </summary>
+        public string ReadString()
+        {
+            var stringLength = ReadUInt16();
+            var bytes = new byte[stringLength];
+            fixed (byte* bytesPtr = bytes)
+            {
+                ReadBytes(bytesPtr, stringLength);
+            }
+            return Encoding.UTF8.GetString(bytes);
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="string"/> into the message. UTF-32 encoded.
+        /// </summary>
+        public void WriteString32(string value)
+        {
+            var data = Encoding.UTF32.GetBytes(value);
+            WriteUInt16((ushort)data.Length);
+            WriteBytes(data, data.Length);
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="string"/> from the message. UTF-32 encoded.
+        /// </summary>
+        public string ReadString32()
+        {
+            var stringLength = ReadUInt16();
+            var bytes = new byte[stringLength];
+            fixed (byte* bytesPtr = bytes)
+            {
+                ReadBytes(bytesPtr, stringLength);
+            }
+            return Encoding.UTF32.GetString(bytes);
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Vector2"/> into the message.
+        /// </summary>
+        public void WriteVector2(Vector2 value)
+        {
+            WriteSingle(value.X);
+            WriteSingle(value.Y);
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Vector2"/> from the message.
+        /// </summary>
+        public Vector2 ReadVector2()
+        {
+            return new Vector2(ReadSingle(), ReadSingle());
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Vector3"/> into the message.
+        /// </summary>
+        public void WriteVector3(Vector3 value)
+        {
+            WriteSingle(value.X);
+            WriteSingle(value.Y);
+            WriteSingle(value.Z);
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Vector3"/> from the message.
+        /// </summary>
+        public Vector3 ReadVector3()
+        {
+            return new Vector3(ReadSingle(), ReadSingle(), ReadSingle());
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Vector4"/> into the message.
+        /// </summary>
+        public void WriteVector4(Vector4 value)
+        {
+            WriteSingle(value.X);
+            WriteSingle(value.Y);
+            WriteSingle(value.Z);
+            WriteSingle(value.W);
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Vector4"/> from the message.
+        /// </summary>
+        public Vector4 ReadVector4()
+        {
+            return new Vector4(ReadSingle(), ReadSingle(), ReadSingle(), ReadSingle());
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Quaternion"/> into the message.
+        /// </summary>
+        public void WriteQuaternion(Quaternion value)
+        {
+            WriteSingle(value.X);
+            WriteSingle(value.Y);
+            WriteSingle(value.Z);
+            WriteSingle(value.W);
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Quaternion"/> from the message.
+        /// </summary>
+        public Quaternion ReadQuaternion()
+        {
+            return new Quaternion(ReadSingle(), ReadSingle(), ReadSingle(), ReadSingle());
+        }
+
+        /// <summary>
+        /// Writes data of type <see cref="Boolean"/> into the message.
+        /// </summary>
+        public void WriteBoolean(bool value)
+        {
+            WriteBytes((byte*)&value, sizeof(bool));
+        }
+
+        /// <summary>
+        /// Reads and returns data of type <see cref="Boolean"/> from the message.
+        /// </summary>
+        public bool ReadBoolean()
+        {
+            bool value = default;
+            ReadBytes((byte*)&value, sizeof(bool));
+            return value;
+        }
     }
 }