Mirror.Batcher Class Reference

Public Member Functions
	Batcher (int threshold)
void	AddMessage (ArraySegment< byte > message, double timeStamp)
bool	GetBatch (NetworkWriter writer)

Static Public Attributes
const int	HeaderSize = sizeof(double)

Detailed Description

Definition at line 16 of file Batcher.cs.

Constructor & Destructor Documentation

Batcher()

Mirror.Batcher.Batcher

(

int

threshold

)

Definition at line 46 of file Batcher.cs.

        {
            this.threshold = threshold;
        }

Member Function Documentation

AddMessage()

void Mirror.Batcher.AddMessage	(	ArraySegment< byte >	message,
		double	timeStamp
	)

Definition at line 54 of file Batcher.cs.

        {
            // when appending to a batch in progress, check final size.
            // if it expands beyond threshold, then we should finalize it first.
            // => less than or exactly threshold is fine.
            //    GetBatch() will finalize it.
            // => see unit tests.
            if (batch != null &&
                batch.Position + message.Count > threshold)
            {
                batches.Enqueue(batch);
                batch = null;
            }
 
            // initialize a new batch if necessary
            if (batch == null)
            {
                // borrow from pool. we return it in GetBatch.
                batch = NetworkWriterPool.Get();
 
                // write timestamp first.
                // -> double precision for accuracy over long periods of time
                // -> batches are per-frame, it doesn't matter which message's
                //    timestamp we use.
                batch.WriteDouble(timeStamp);
            }
 
            // add serialization to current batch. even if > threshold.
            // -> we do allow > threshold sized messages as single batch
            // -> WriteBytes instead of WriteSegment because the latter
            //    would add a size header. we want to write directly.
            batch.WriteBytes(message.Array, message.Offset, message.Count);
        }

GetBatch()

bool Mirror.Batcher.GetBatch

(

NetworkWriter

writer

)

Definition at line 106 of file Batcher.cs.

        {
            // get first batch from queue (if any)
            if (batches.TryDequeue(out NetworkWriterPooled first))
            {
                CopyAndReturn(first, writer);
                return true;
            }
 
            // if queue was empty, we can send the batch in progress.
            if (batch != null)
            {
                CopyAndReturn(batch, writer);
                batch = null;
                return true;
            }
 
            // nothing was written
            return false;
        }

Member Data Documentation

HeaderSize

const int Mirror.Batcher.HeaderSize = sizeof(double)

static

Definition at line 33 of file Batcher.cs.