Show / Hide Table of Contents

Class SyncQueue<T>

Inheritance
object
InternalBaseClass
SyncableField
SyncQueue<T>
Implements
IReadOnlyCollection<T>
IEnumerable<T>
ICollection
IEnumerable
Inherited Members
SyncableField.IsClient
SyncableField.IsServer
SyncableField.ParentEntity
SyncableField.ParentEntityLogic
SyncableField.ExecuteRPC(in RemoteCall)
SyncableField.ExecuteRPC<T>(in RemoteCall<T>, T)
SyncableField.ExecuteRPC<T>(in RemoteCallSpan<T>, ReadOnlySpan<T>)
SyncableField.ExecuteRPC<T>(in RemoteCallSerializable<T>, T)
Namespace: LiteEntitySystem.Extensions
Assembly: LiteEntitySystem.dll
Syntax
public class SyncQueue<T> : SyncableField, IReadOnlyCollection<T>, IEnumerable<T>, ICollection, IEnumerable where T : unmanaged
Type Parameters
Name Description
T

Properties

Count

Gets the number of elements in the collection.

Declaration
public int Count { get; }
Property Value
Type Description
int

The number of elements in the collection.

IsRollbackSupported

Is supported rollback by this syncable field

Declaration
public override bool IsRollbackSupported { get; }
Property Value
Type Description
bool
Overrides
SyncableField.IsRollbackSupported

IsSynchronized

Gets a value indicating whether access to the ICollection is synchronized (thread safe).

Declaration
public bool IsSynchronized { get; }
Property Value
Type Description
bool

true if access to the ICollection is synchronized (thread safe); otherwise, false.

SyncRoot

Gets an object that can be used to synchronize access to the ICollection.

Declaration
public object SyncRoot { get; }
Property Value
Type Description
object

An object that can be used to synchronize access to the ICollection.

Methods

AfterReadRPC()

Declaration
protected override void AfterReadRPC()
Overrides
SyncableField.AfterReadRPC()

BeforeReadRPC()

Declaration
protected override void BeforeReadRPC()
Overrides
SyncableField.BeforeReadRPC()

Clear()

Declaration
public void Clear()

Contains(T)

Declaration
public bool Contains(T item)
Parameters
Type Name Description
T item
Returns
Type Description
bool

CopyTo(Array, int)

Copies the elements of the ICollection to an Array, starting at a particular Array index.

Declaration
public void CopyTo(Array array, int index)
Parameters
Type Name Description
Array array

The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.

int index

The zero-based index in array at which copying begins.

Exceptions
Type Condition
ArgumentNullException

array is null.

ArgumentOutOfRangeException

index is less than zero.

ArgumentException
<code class="paramref">array</code> is multidimensional.  

-or-
The number of elements in the source ICollection is greater than the available space from index to the end of the destination array.
-or-
The type of the source ICollection cannot be cast automatically to the type of the destination array.

Dequeue()

Declaration
public T Dequeue()
Returns
Type Description
T

Enqueue(T)

Declaration
public void Enqueue(T item)
Parameters
Type Name Description
T item

GetEnumerator()

Declaration
public Queue<T>.Enumerator GetEnumerator()
Returns
Type Description
Queue<T>.Enumerator

OnRollback()

Declaration
protected override void OnRollback()
Overrides
SyncableField.OnRollback()

OnSyncRequested()

Declaration
protected override void OnSyncRequested()
Overrides
InternalBaseClass.OnSyncRequested()

Peek()

Declaration
public T Peek()
Returns
Type Description
T

RegisterRPC(ref SyncableRPCRegistrator)

Declaration
protected override void RegisterRPC(ref SyncableRPCRegistrator r)
Parameters
Type Name Description
SyncableRPCRegistrator r
Overrides
SyncableField.RegisterRPC(ref SyncableRPCRegistrator)

TryDequeue(out T)

Declaration
public bool TryDequeue(out T item)
Parameters
Type Name Description
T item
Returns
Type Description
bool

TryPeek(out T)

Declaration
public bool TryPeek(out T item)
Parameters
Type Name Description
T item
Returns
Type Description
bool

Implements

IReadOnlyCollection<T>
IEnumerable<T>
ICollection
IEnumerable
In this article
Back to top Generated by DocFX