Packet class used for data representation - used for reading and writing data that will be send or were received, includes methods for de-/serialization of different data types. More...

Public Types
enum	ServerPackets { welcome = 1 , SpawnUser , DisconnectUser , Latency , Message , HmacKey , AuthToken , MessageAll , TransformUpdate , AnimationUpdate , BandwidthReply , ThroughputReply }
	Defined packets sent to Clients by Server. More...
enum	ClientPackets { welcomeReceived = 1 , MeassureRequest , DisconnectRequest , MessageToUserRequest , MessageToAllRequest , HmacKey , AutToken , TransformChange , AnimationChange , BandwidthRequest , ThroughputRequest }
	Defined packets sent to Server by Client. More...

Public Member Functions
	Packet ()
	Packet (int packetId)
	Packet (byte[] data)
void	Write (string text)
	Write string data.
string	ReadString (bool ChangeReadPosition=true)
	Read string data.
void	Write (int data)
	Write int data.
int	ReadInt (bool changeReadPosition=true)
	Read int data.
void	Write (float data)
	Write float data.
float	ReadFloat (bool changeReadPosition=true)
	Read float data.
void	Write (bool data)
	Write bool data.
bool	ReadBool (bool changeReadPosition=true)
	Read bool data.
void	Write (byte data)
	Write byte data.
byte	ReadByte (bool changeReadPosition=true)
	Read byte data.
void	Write (byte[] data)
	Write byte array data.
byte[]	ReadBytes (int arrayLength, bool changeReadPosition=true)
	read byte array data
void	Write (short data)
	Write short data.
short	ReadShort (bool changeReadPos=true)
	Read short data.
void	Write (Vector3 vector)
	Write Vector3 data.
Vector3	ReadVector3 (bool changeReadPos=true)
	Read Vector3 data.
void	Write (Quaternion data)
	Write Quaternion data.
Quaternion	ReadQuaternion (bool changeReadPos=true)
	Read Quaternion data.
void	ClearPacket (bool clear)
byte[]	ConvertToArray ()
void	AddIntAtStart (int number)
void	SizeOfDataAtStart ()
int	DataLength ()
int	UnreadLength ()
void	AddBytesToBuffers (byte[] Data)
byte[]	GetDataWithoutHmac ()
	Return data without HMAC.
byte[]	GetHmac ()
	return HMAC from data

Private Attributes
List< byte >	packetDataBuffer
	Dynamic data list.
byte[]	dataBuffer
	Byte array for reading data.
int	readPosition

Detailed Description

Packet class used for data representation - used for reading and writing data that will be send or were received, includes methods for de-/serialization of different data types.

Definition at line 9 of file Packet.cs.

Member Enumeration Documentation

◆ ClientPackets

enum Packet.ClientPackets

Defined packets sent to Server by Client.

Enumerator
welcomeReceived
MeassureRequest
DisconnectRequest
MessageToUserRequest
MessageToAllRequest
HmacKey
AutToken
TransformChange
AnimationChange
BandwidthRequest
ThroughputRequest

Definition at line 351 of file Packet.cs.

    {
        welcomeReceived = 1, 
        MeassureRequest,
        DisconnectRequest,
        MessageToUserRequest,
        MessageToAllRequest,
        HmacKey,
        AutToken,
        TransformChange,
        AnimationChange,
        BandwidthRequest,
        ThroughputRequest
    }

◆ ServerPackets

enum Packet.ServerPackets

Defined packets sent to Clients by Server.

Enumerator
welcome
SpawnUser
DisconnectUser
Latency
Message
HmacKey
AuthToken
MessageAll
TransformUpdate
AnimationUpdate
BandwidthReply
ThroughputReply

Definition at line 332 of file Packet.cs.

    {
        welcome = 1, 
        SpawnUser,
        DisconnectUser,
        Latency,
        Message,
        HmacKey,
        AuthToken,
        MessageAll,
        TransformUpdate,
        AnimationUpdate,
        BandwidthReply,
        ThroughputReply
    }

Constructor & Destructor Documentation

◆ Packet() [1/3]

Packet.Packet ( )

Definition at line 23 of file Packet.cs.

    {
        readPosition = 0; 
        packetDataBuffer = new List<byte>(); 
    }

◆ Packet() [2/3]

Packet.Packet ( int packetId )

Definition at line 28 of file Packet.cs.

    {
        readPosition = 0;  
        packetDataBuffer = new List<byte>(); 
        Write(packetId); 
    }

◆ Packet() [3/3]

Packet.Packet ( byte[] data )

Definition at line 34 of file Packet.cs.

    {
        readPosition = 0;  
        packetDataBuffer = new List<byte>(); 
        AddBytesToBuffers(data); 
    }

Member Function Documentation

◆ AddBytesToBuffers()

void Packet.AddBytesToBuffers ( byte[] Data )

Definition at line 309 of file Packet.cs.

    {
        Write(Data); 
        dataBuffer = packetDataBuffer.ToArray(); 
    }

◆ AddIntAtStart()

void Packet.AddIntAtStart ( int number )

Definition at line 292 of file Packet.cs.

    {
        packetDataBuffer.InsertRange(0, BitConverter.GetBytes(number)); 
    }

◆ ClearPacket()

void Packet.ClearPacket ( bool clear )

Definition at line 274 of file Packet.cs.

    {
        if (clear == false)
        {
            readPosition -= 4; 
        }
        else
        {
            packetDataBuffer.Clear();
            readPosition = 0;
            dataBuffer = null;
        }
    }

◆ ConvertToArray()

byte[] Packet.ConvertToArray ( )

Definition at line 287 of file Packet.cs.

    {
        dataBuffer = packetDataBuffer.ToArray();
        return dataBuffer;
    }

◆ DataLength()

int Packet.DataLength ( )

Definition at line 300 of file Packet.cs.

    {
        return packetDataBuffer.Count;
    }

◆ GetDataWithoutHmac()

byte[] Packet.GetDataWithoutHmac ( )

Return data without HMAC.

Definition at line 317 of file Packet.cs.

    {
        return packetDataBuffer.GetRange(0, packetDataBuffer.Count - 32).ToArray();
    }

◆ GetHmac()

byte[] Packet.GetHmac ( )

return HMAC from data

Definition at line 324 of file Packet.cs.

    {
        return packetDataBuffer.GetRange(packetDataBuffer.Count - 32, 32).ToArray();
    }

◆ ReadBool()

bool Packet.ReadBool ( bool changeReadPosition = true )

Read bool data.

Definition at line 134 of file Packet.cs.

    {
        if (packetDataBuffer.Count > readPosition) 
        {
            bool data = BitConverter.ToBoolean(dataBuffer, readPosition);
            if (changeReadPosition)
            {
                readPosition += 1;
            }
            return data; 
        }
        else
        {
            throw new Exception("Error reading bool");
        }
    }

◆ ReadByte()

byte Packet.ReadByte ( bool changeReadPosition = true )

Read byte data.

Definition at line 161 of file Packet.cs.

    {
        if (packetDataBuffer.Count > readPosition)
        {
            byte data = dataBuffer[readPosition];
            if (changeReadPosition == true)
            {
                readPosition += 1;
            }
            return data;
        }
        else
        {
            throw new Exception("Error reading byte");
        }
    }

◆ ReadBytes()

byte[] Packet.ReadBytes	(	int	arrayLength,
		bool	changeReadPosition = true )

read byte array data

Definition at line 188 of file Packet.cs.

    {
        if (packetDataBuffer.Count > readPosition)
        {
            byte[] ByteArray = packetDataBuffer.GetRange(readPosition, arrayLength).ToArray();
            if (changeReadPosition == true)
            {
                readPosition += arrayLength;
            }
            return ByteArray;
        }
        else
        {
            throw new Exception("Error reading byte array");
        }
    }

◆ ReadFloat()

float Packet.ReadFloat ( bool changeReadPosition = true )

Read float data.

Definition at line 107 of file Packet.cs.

    {
        if (packetDataBuffer.Count > readPosition) 
        {
            float floatingPointNum = BitConverter.ToSingle(dataBuffer, readPosition);
            if (changeReadPosition == true)
            {
                readPosition += 4;
            }
            return floatingPointNum; 
        }
        else
        {
            throw new Exception("Error reading float");
        }
    }

◆ ReadInt()

int Packet.ReadInt ( bool changeReadPosition = true )

Read int data.

Definition at line 80 of file Packet.cs.

    {
        if (packetDataBuffer.Count > readPosition) 
        {
            int data = BitConverter.ToInt32(dataBuffer, readPosition); 
            if (changeReadPosition == true)
            {
                readPosition += 4;
            }
            return data; 
        }
        else
        {
            throw new Exception("Error reading int");
        }
    }

◆ ReadQuaternion()

Quaternion Packet.ReadQuaternion ( bool changeReadPos = true )

Read Quaternion data.

Definition at line 263 of file Packet.cs.

    {
        float x = ReadFloat(changeReadPos);
        float y = ReadFloat(changeReadPos);
        float z = ReadFloat(changeReadPos);
        float w = ReadFloat(changeReadPos);
        return new Quaternion(x, y, z, w);
    }

◆ ReadShort()

short Packet.ReadShort ( bool changeReadPos = true )

Read short data.

Definition at line 215 of file Packet.cs.

    {
        if (packetDataBuffer.Count > readPosition)
        {
            short data = BitConverter.ToInt16(dataBuffer, readPosition);
            if (changeReadPos == true)
            {
                readPosition += 2;
            }
            return data;
        }
        else
        {
            throw new Exception("Error reading short");
        }
    }

◆ ReadString()

string Packet.ReadString ( bool ChangeReadPosition = true )

Read string data.

Definition at line 52 of file Packet.cs.

    {
        try
        {
            int textLength = ReadInt(); 
            string text = Encoding.ASCII.GetString(dataBuffer, readPosition, textLength); 
            if (ChangeReadPosition == true && text.Length > 0) 
            {
                readPosition += textLength; 
            }
            return text; 
        }
        catch
        {
            throw new Exception("Error reading string");
        }
    }

◆ ReadVector3()

Vector3 Packet.ReadVector3 ( bool changeReadPos = true )

Read Vector3 data.

Definition at line 243 of file Packet.cs.

    {
        float x = ReadFloat(changeReadPos);
        float y = ReadFloat(changeReadPos);
        float z = ReadFloat(changeReadPos);
        return new Vector3(x, y, z);
    }

◆ SizeOfDataAtStart()

void Packet.SizeOfDataAtStart ( )

Definition at line 296 of file Packet.cs.

    {
        packetDataBuffer.InsertRange(0, BitConverter.GetBytes(packetDataBuffer.Count)); 
    }

◆ UnreadLength()

int Packet.UnreadLength ( )

Definition at line 304 of file Packet.cs.

    {
        int actual_lenghth = DataLength();
        return actual_lenghth - readPosition; 
    }

◆ Write() [1/9]

void Packet.Write ( bool data )

Write bool data.

Definition at line 127 of file Packet.cs.

    {
        packetDataBuffer.AddRange(BitConverter.GetBytes(data));
    }

◆ Write() [2/9]

void Packet.Write ( byte data )

Write byte data.

Definition at line 154 of file Packet.cs.

    {
        packetDataBuffer.Add(data);
    }

◆ Write() [3/9]

void Packet.Write ( byte[] data )

Write byte array data.

Definition at line 181 of file Packet.cs.

    {
        packetDataBuffer.AddRange(data);
    }

◆ Write() [4/9]

void Packet.Write ( float data )

Write float data.

Definition at line 100 of file Packet.cs.

    {
        packetDataBuffer.AddRange(BitConverter.GetBytes(data));
    }

◆ Write() [5/9]

void Packet.Write ( int data )

Write int data.

Definition at line 73 of file Packet.cs.

    {
        packetDataBuffer.AddRange(BitConverter.GetBytes(data));
    }

◆ Write() [6/9]

void Packet.Write ( Quaternion data )

Write Quaternion data.

Definition at line 253 of file Packet.cs.

    {
        Write(data.x);
        Write(data.y);
        Write(data.z);
        Write(data.w);
    }

◆ Write() [7/9]

void Packet.Write ( short data )

Write short data.

Definition at line 208 of file Packet.cs.

    {
        packetDataBuffer.AddRange(BitConverter.GetBytes(data));
    }

◆ Write() [8/9]

void Packet.Write ( string text )

Write string data.

Definition at line 44 of file Packet.cs.

    {
        Write(text.Length); 
        packetDataBuffer.AddRange(Encoding.ASCII.GetBytes(text));
    }

◆ Write() [9/9]

void Packet.Write ( Vector3 vector )

Write Vector3 data.

Definition at line 234 of file Packet.cs.

    {
        Write(vector.x);
        Write(vector.y);
        Write(vector.z);
    }

Member Data Documentation

◆ dataBuffer

byte [] Packet.dataBuffer

private

Byte array for reading data.

Definition at line 18 of file Packet.cs.

◆ packetDataBuffer

List<byte> Packet.packetDataBuffer

private

Dynamic data list.

Definition at line 14 of file Packet.cs.

◆ readPosition

int Packet.readPosition

private

Definition at line 20 of file Packet.cs.

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ClientPackets

◆ ServerPackets

Constructor & Destructor Documentation

◆ Packet() [1/3]

◆ Packet() [2/3]

◆ Packet() [3/3]

Member Function Documentation

◆ AddBytesToBuffers()

◆ AddIntAtStart()

◆ ClearPacket()

◆ ConvertToArray()

◆ DataLength()

◆ GetDataWithoutHmac()

◆ GetHmac()

◆ ReadBool()

◆ ReadByte()

◆ ReadBytes()

◆ ReadFloat()

◆ ReadInt()

◆ ReadQuaternion()

◆ ReadShort()

◆ ReadString()

◆ ReadVector3()

◆ SizeOfDataAtStart()

◆ UnreadLength()

◆ Write() [1/9]

◆ Write() [2/9]

◆ Write() [3/9]

◆ Write() [4/9]

◆ Write() [5/9]

◆ Write() [6/9]

◆ Write() [7/9]

◆ Write() [8/9]

◆ Write() [9/9]

Member Data Documentation

◆ dataBuffer

◆ packetDataBuffer

◆ readPosition