Mirror.SyncIDictionary< TKey, TValue > Class Template Reference

Inheritance diagram for Mirror.SyncIDictionary< TKey, TValue >:

Public Member Functions
delegate void	SyncDictionaryChanged (Operation op, TKey key, TValue item)
override void	Reset ()
	Resets the SyncObject so that it can be re-used More...
override void	ClearChanges ()
	Discard all the queued changes More...
	SyncIDictionary (IDictionary< TKey, TValue > objects)
override void	OnSerializeAll (NetworkWriter writer)
	Write a full copy of the object More...
override void	OnSerializeDelta (NetworkWriter writer)
	Write the changes made to the object since last sync More...
override void	OnDeserializeAll (NetworkReader reader)
	Reads a full copy of the object More...
override void	OnDeserializeDelta (NetworkReader reader)
	Reads the changes made to the object since last sync More...
void	Clear ()
bool	ContainsKey (TKey key)
bool	Remove (TKey key)
bool	TryGetValue (TKey key, out TValue value)
void	Add (TKey key, TValue value)
void	Add (KeyValuePair< TKey, TValue > item)
bool	Contains (KeyValuePair< TKey, TValue > item)
void	CopyTo (KeyValuePair< TKey, TValue >[] array, int arrayIndex)
bool	Remove (KeyValuePair< TKey, TValue > item)
IEnumerator< KeyValuePair< TKey, TValue > >	GetEnumerator ()
abstract void	ClearChanges ()
	Discard all the queued changes More...
abstract void	OnSerializeAll (NetworkWriter writer)
	Write a full copy of the object More...
abstract void	OnSerializeDelta (NetworkWriter writer)
	Write the changes made to the object since last sync More...
abstract void	OnDeserializeAll (NetworkReader reader)
	Reads a full copy of the object More...
abstract void	OnDeserializeDelta (NetworkReader reader)
	Reads the changes made to the object since last sync More...
abstract void	Reset ()
	Resets the SyncObject so that it can be re-used More...

Protected Attributes
readonly IDictionary< TKey, TValue >	objects

Properties
int	Count [get]
bool	IsReadOnly [get]
ICollection< TKey >	Keys [get]
ICollection< TValue >	Values [get]
TValue	this[TKey i] [get, set]

Events
SyncDictionaryChanged	Callback

Additional Inherited Members
Public Attributes inherited from Mirror.SyncObject
Action	OnDirty
	Used internally to set owner NetworkBehaviour's dirty mask bit when changed. More...
Func< bool >	IsRecording = () => true
	Used internally to check if we are currently tracking changes. More...

Detailed Description

Definition at line 6 of file SyncDictionary.cs.

Constructor & Destructor Documentation

SyncIDictionary()

Mirror.SyncIDictionary< TKey, TValue >.SyncIDictionary

(

IDictionary< TKey, TValue >

objects

)

Definition at line 64 of file SyncDictionary.cs.

        {
            this.objects = objects;
        }

Member Function Documentation

Add()

void Mirror.SyncIDictionary< TKey, TValue >.Add	(	TKey	key,
		TValue	value
	)

Definition at line 254 of file SyncDictionary.cs.

        {
            objects.Add(key, value);
            AddOperation(Operation.OP_ADD, key, value);
        }

Clear()

void Mirror.SyncIDictionary< TKey, TValue >.Clear

(

)

Definition at line 216 of file SyncDictionary.cs.

        {
            objects.Clear();
            AddOperation(Operation.OP_CLEAR, default, default);
        }

ClearChanges()

override void Mirror.SyncIDictionary< TKey, TValue >.ClearChanges ( )

virtual

Discard all the queued changes

Implements Mirror.SyncObject.

Contains()

bool Mirror.SyncIDictionary< TKey, TValue >.Contains

(

KeyValuePair< TKey, TValue >

item

)

Definition at line 262 of file SyncDictionary.cs.

        {
            return TryGetValue(item.Key, out TValue val) && EqualityComparer<TValue>.Default.Equals(val, item.Value);
        }

CopyTo()

void Mirror.SyncIDictionary< TKey, TValue >.CopyTo	(	KeyValuePair< TKey, TValue >[]	array,
		int	arrayIndex
	)

Definition at line 267 of file SyncDictionary.cs.

        {
            if (arrayIndex < 0 || arrayIndex > array.Length)
            {
                throw new System.ArgumentOutOfRangeException(nameof(arrayIndex), "Array Index Out of Range");
            }
            if (array.Length - arrayIndex < Count)
            {
                throw new System.ArgumentException("The number of items in the SyncDictionary is greater than the available space from arrayIndex to the end of the destination array");
            }
 
            int i = arrayIndex;
            foreach (KeyValuePair<TKey, TValue> item in objects)
            {
                array[i] = item;
                i++;
            }
        }

OnDeserializeAll()

override void Mirror.SyncIDictionary< TKey, TValue >.OnDeserializeAll ( NetworkReader  reader )

virtual

Reads a full copy of the object

Implements Mirror.SyncObject.

Definition at line 134 of file SyncDictionary.cs.

        {
            // This list can now only be modified by synchronization
            IsReadOnly = true;
 
            // if init,  write the full list content
            int count = (int)reader.ReadUInt();
 
            objects.Clear();
            changes.Clear();
 
            for (int i = 0; i < count; i++)
            {
                TKey key = reader.Read<TKey>();
                TValue obj = reader.Read<TValue>();
                objects.Add(key, obj);
            }
 
            // We will need to skip all these changes
            // the next time the list is synchronized
            // because they have already been applied
            changesAhead = (int)reader.ReadUInt();
        }

OnDeserializeDelta()

override void Mirror.SyncIDictionary< TKey, TValue >.OnDeserializeDelta ( NetworkReader  reader )

virtual

Reads the changes made to the object since last sync

Implements Mirror.SyncObject.

Definition at line 158 of file SyncDictionary.cs.

        {
            // This list can now only be modified by synchronization
            IsReadOnly = true;
 
            int changesCount = (int)reader.ReadUInt();
 
            for (int i = 0; i < changesCount; i++)
            {
                Operation operation = (Operation)reader.ReadByte();
 
                // apply the operation only if it is a new change
                // that we have not applied yet
                bool apply = changesAhead == 0;
                TKey key = default;
                TValue item = default;
 
                switch (operation)
                {
                    case Operation.OP_ADD:
                    case Operation.OP_SET:
                        key = reader.Read<TKey>();
                        item = reader.Read<TValue>();
                        if (apply)
                        {
                            objects[key] = item;
                        }
                        break;
 
                    case Operation.OP_CLEAR:
                        if (apply)
                        {
                            objects.Clear();
                        }
                        break;
 
                    case Operation.OP_REMOVE:
                        key = reader.Read<TKey>();
                        item = reader.Read<TValue>();
                        if (apply)
                        {
                            objects.Remove(key);
                        }
                        break;
                }
 
                if (apply)
                {
                    Callback?.Invoke(operation, key, item);
                }
                // we just skipped this change
                else
                {
                    changesAhead--;
                }
            }
        }

OnSerializeAll()

override void Mirror.SyncIDictionary< TKey, TValue >.OnSerializeAll ( NetworkWriter  writer )

virtual

Write a full copy of the object

Implements Mirror.SyncObject.

Definition at line 92 of file SyncDictionary.cs.

        {
            // if init, write the full list content
            writer.WriteUInt((uint)objects.Count);
 
            foreach (KeyValuePair<TKey, TValue> syncItem in objects)
            {
                writer.Write(syncItem.Key);
                writer.Write(syncItem.Value);
            }
 
            // all changes have been applied already
            // thus the client will need to skip all the pending changes
            // or they would be applied again.
            // So we write how many changes are pending
            writer.WriteUInt((uint)changes.Count);
        }

OnSerializeDelta()

override void Mirror.SyncIDictionary< TKey, TValue >.OnSerializeDelta ( NetworkWriter  writer )

virtual

Write the changes made to the object since last sync

Implements Mirror.SyncObject.

Definition at line 110 of file SyncDictionary.cs.

        {
            // write all the queued up changes
            writer.WriteUInt((uint)changes.Count);
 
            for (int i = 0; i < changes.Count; i++)
            {
                Change change = changes[i];
                writer.WriteByte((byte)change.operation);
 
                switch (change.operation)
                {
                    case Operation.OP_ADD:
                    case Operation.OP_REMOVE:
                    case Operation.OP_SET:
                        writer.Write(change.key);
                        writer.Write(change.item);
                        break;
                    case Operation.OP_CLEAR:
                        break;
                }
            }
        }

Remove() [1/2]

bool Mirror.SyncIDictionary< TKey, TValue >.Remove

(

KeyValuePair< TKey, TValue >

item

)

Definition at line 286 of file SyncDictionary.cs.

        {
            bool result = objects.Remove(item.Key);
            if (result)
            {
                AddOperation(Operation.OP_REMOVE, item.Key, item.Value);
            }
            return result;
        }

Remove() [2/2]

bool Mirror.SyncIDictionary< TKey, TValue >.Remove

(

TKey

key

)

Definition at line 224 of file SyncDictionary.cs.

        {
            if (objects.TryGetValue(key, out TValue item) && objects.Remove(key))
            {
                AddOperation(Operation.OP_REMOVE, key, item);
                return true;
            }
            return false;
        }

Reset()

override void Mirror.SyncIDictionary< TKey, TValue >.Reset ( )

virtual

Resets the SyncObject so that it can be re-used

Implements Mirror.SyncObject.

Definition at line 44 of file SyncDictionary.cs.

        {
            IsReadOnly = false;
            changes.Clear();
            changesAhead = 0;
            objects.Clear();
        }

Member Data Documentation

objects

readonly IDictionary<TKey, TValue> Mirror.SyncIDictionary< TKey, TValue >.objects

protected

Definition at line 10 of file SyncDictionary.cs.

Property Documentation

Count

int Mirror.SyncIDictionary< TKey, TValue >.Count

get

Definition at line 12 of file SyncDictionary.cs.

IsReadOnly

bool Mirror.SyncIDictionary< TKey, TValue >.IsReadOnly

get

Definition at line 13 of file SyncDictionary.cs.

{ get; private set; }

Keys

ICollection<TKey> Mirror.SyncIDictionary< TKey, TValue >.Keys

get

Definition at line 52 of file SyncDictionary.cs.

this[TKey i]

TValue Mirror.SyncIDictionary< TKey, TValue >.this[TKey i]

getset

Definition at line 234 of file SyncDictionary.cs.

        {
            get => objects[i];
            set
            {
                if (ContainsKey(i))
                {
                    objects[i] = value;
                    AddOperation(Operation.OP_SET, i, value);
                }
                else
                {
                    objects[i] = value;
                    AddOperation(Operation.OP_ADD, i, value);
                }
            }
        }

Values

ICollection<TValue> Mirror.SyncIDictionary< TKey, TValue >.Values

get

Definition at line 54 of file SyncDictionary.cs.

Event Documentation

Callback

SyncDictionaryChanged Mirror.SyncIDictionary< TKey, TValue >.Callback

Definition at line 14 of file SyncDictionary.cs.