Mirror.NetworkReader Class Reference

Network Reader for most simple types like floats, ints, buffers, structs, etc. Use NetworkReaderPool.GetReader() to avoid allocations. More...

Inheritance diagram for Mirror.NetworkReader:

Public Member Functions
	NetworkReader (byte[] bytes)
	NetworkReader (ArraySegment< byte > segment)
void	SetBuffer (byte[] bytes)
void	SetBuffer (ArraySegment< byte > segment)
byte	ReadByte ()
byte[]	ReadBytes (byte[] bytes, int count)
	Read 'count' bytes into the bytes array More...
ArraySegment< byte >	ReadBytesSegment (int count)
	Read 'count' bytes allocation-free as ArraySegment that points to the internal array. More...
override string	ToString ()
T	Read< T > ()
	Reads any data type that mirror supports. Uses weaver populated Reader(T).read More...

Public Attributes
int	Position
	Next position to read from the buffer More...

Properties
int	Length [get]
	Total number of bytes to read from buffer More...
int	Remaining [get]
	Remaining bytes that can be read, for convenience. More...

Detailed Description

Network Reader for most simple types like floats, ints, buffers, structs, etc. Use NetworkReaderPool.GetReader() to avoid allocations.

Definition at line 13 of file NetworkReader.cs.

Constructor & Destructor Documentation

NetworkReader() [1/2]

Mirror.NetworkReader.NetworkReader

(

byte[]

bytes

)

Definition at line 39 of file NetworkReader.cs.

        {
            buffer = new ArraySegment<byte>(bytes);
        }

NetworkReader() [2/2]

Mirror.NetworkReader.NetworkReader

(

ArraySegment< byte >

segment

)

Definition at line 44 of file NetworkReader.cs.

        {
            buffer = segment;
        }

Member Function Documentation

Read< T >()

T Mirror.NetworkReader.Read< T >

(

)

Reads any data type that mirror supports. Uses weaver populated Reader(T).read

Definition at line 200 of file NetworkReader.cs.

        {
            Func<NetworkReader, T> readerDelegate = Reader<T>.read;
            if (readerDelegate == null)
            {
                Debug.LogError($"No reader found for {typeof(T)}. Use a type supported by Mirror or define a custom reader");
                return default;
            }
            return readerDelegate(this);
        }

ReadBytes()

byte[] Mirror.NetworkReader.ReadBytes	(	byte[]	bytes,
		int	count
	)

Read 'count' bytes into the bytes array

Definition at line 161 of file NetworkReader.cs.

        {
            // check if passed byte array is big enough
            if (count > bytes.Length)
            {
                throw new EndOfStreamException($"ReadBytes can't read {count} + bytes because the passed byte[] only has length {bytes.Length}");
            }
            // check if within buffer limits
            if (Position + count > buffer.Count)
            {
                throw new EndOfStreamException($"ReadBytesSegment can't read {count} bytes because it would read past the end of the stream. {ToString()}");
            }
 
            Array.Copy(buffer.Array, buffer.Offset + Position, bytes, 0, count);
            Position += count;
            return bytes;
        }

ReadBytesSegment()

ArraySegment< byte > Mirror.NetworkReader.ReadBytesSegment

(

int

count

)

Read 'count' bytes allocation-free as ArraySegment that points to the internal array.

Definition at line 180 of file NetworkReader.cs.

        {
            // check if within buffer limits
            if (Position + count > buffer.Count)
            {
                throw new EndOfStreamException($"ReadBytesSegment can't read {count} bytes because it would read past the end of the stream. {ToString()}");
            }
 
            // return the segment
            ArraySegment<byte> result = new ArraySegment<byte>(buffer.Array, buffer.Offset + Position, count);
            Position += count;
            return result;
        }

SetBuffer() [1/2]

void Mirror.NetworkReader.SetBuffer

(

ArraySegment< byte >

segment

)

Definition at line 59 of file NetworkReader.cs.

        {
            buffer = segment;
            Position = 0;
        }

SetBuffer() [2/2]

void Mirror.NetworkReader.SetBuffer

(

byte[]

bytes

)

Definition at line 52 of file NetworkReader.cs.

        {
            buffer = new ArraySegment<byte>(bytes);
            Position = 0;
        }

Member Data Documentation

Position

int Mirror.NetworkReader.Position

Next position to read from the buffer

Definition at line 23 of file NetworkReader.cs.

Property Documentation

Length

int Mirror.NetworkReader.Length

get

Total number of bytes to read from buffer

Definition at line 26 of file NetworkReader.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => buffer.Count;
        }

Remaining

int Mirror.NetworkReader.Remaining

get

Remaining bytes that can be read, for convenience.

Definition at line 33 of file NetworkReader.cs.

        {
            [MethodImpl(MethodImplOptions.AggressiveInlining)]
            get => Length - Position;
        }