mirror of
https://bitbucket.org/Ioncannon/project-meteor-server.git
synced 2025-04-02 19:42:05 -04:00
275 lines
23 KiB
XML
275 lines
23 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Cyotek.Collections.Generic.CircularBuffer</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Cyotek.Collections.Generic.CircularBuffer`1">
|
|
<summary>
|
|
Represents a first-in, first-out collection of objects using a fixed buffer and automatic overwrite support.
|
|
</summary>
|
|
<typeparam name="T">Specifies the type of elements in the buffer.</typeparam>
|
|
<remarks>
|
|
<para>The capacity of a <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> is the number of elements the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> can
|
|
hold. If an attempt is made to put more items in the buffer than available capacity, items at the start of the buffer are
|
|
automatically overwritten. This behavior can be modified via the <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.AllowOverwrite"/> property.</para>
|
|
<para>CircularBuffer{T} accepts <c>null</c> as a valid value for reference types and allows duplicate elements.</para>
|
|
<para>The <see cref="M:Cyotek.Collections.Generic.CircularBuffer`1.Get"/> methods will remove the items that are returned from the CircularBuffer{T}. To view the contents of the CircularBuffer{T} without removing items, use the <see cref="M:Cyotek.Collections.Generic.CircularBuffer`1.Peek"/> or <see cref="M:Cyotek.Collections.Generic.CircularBuffer`1.PeekLast"/> methods.</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.#ctor(System.Int32)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> class that is empty and has the specified initial capacity and default overwrite behavior.
|
|
</summary>
|
|
<param name="capacity">The maximum capcity of the buffer.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.#ctor(System.Int32,System.Boolean)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> class that is empty and has the specified initial capacity and overwrite behavior.
|
|
</summary>
|
|
<param name="capacity">The maximum capcity of the buffer.</param>
|
|
<param name="allowOverwrite">If set to <c>true</c> the buffer will automatically overwrite the oldest items when full.</param>
|
|
<exception cref="T:System.ArgumentException">Thown if the <paramref name="capacity"/> is less than zero.</exception>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Clear">
|
|
<summary>
|
|
Removes all items from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Contains(`0)">
|
|
<summary>
|
|
Determines whether the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> contains a specific value.
|
|
</summary>
|
|
<param name="item">The object to locate in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</param>
|
|
<returns><c>true</c> if <paramref name="item"/> is found in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>; otherwise, <c>false</c>.</returns>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.CopyTo(`0[])">
|
|
<summary>
|
|
Copies the entire <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> to a compatible one-dimensional array, starting at the beginning of the target array.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.CopyTo(`0[],System.Int32)">
|
|
<summary>
|
|
Copies the entire <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> to a compatible one-dimensional array, starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.CopyTo(System.Int32,`0[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Copies a range of elements from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> to a compatible one-dimensional array, starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="index">The zero-based index in the source <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> at which copying begins.</param>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
|
|
<param name="count">The number of elements to copy.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Get(System.Int32)">
|
|
<summary>
|
|
Removes and returns the specified number of objects from the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<param name="count">The number of elements to remove and return from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</param>
|
|
<returns>The objects that are removed from the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Get(`0[])">
|
|
<summary>
|
|
Copies and removes the specified number elements from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> to a compatible one-dimensional array, starting at the beginning of the target array.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<returns>The actual number of elements copied into <paramref name="array"/>.</returns>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Get(`0[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Copies and removes the specified number elements from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> to a compatible one-dimensional array, starting at the specified index of the target array.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
|
|
<param name="count">The number of elements to copy.</param>
|
|
<returns>The actual number of elements copied into <paramref name="array"/>.</returns>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Get">
|
|
<summary>
|
|
Removes and returns the object at the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<returns>The object that is removed from the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the buffer is empty.</exception>
|
|
<remarks>This method is similar to the <see cref="M:Cyotek.Collections.Generic.CircularBuffer`1.Peek"/> method, but <c>Peek</c> does not modify the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</remarks>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<returns>A <see cref="T:System.Collections.Generic.IEnumerator`1"/> for the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Peek">
|
|
<summary>
|
|
Returns the object at the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> without removing it.
|
|
</summary>
|
|
<returns>The object at the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the buffer is empty.</exception>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Peek(System.Int32)">
|
|
<summary>
|
|
Returns the specified number of objects from the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<param name="count">The number of elements to return from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</param>
|
|
<returns>The objects that from the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the buffer is empty.</exception>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.PeekLast">
|
|
<summary>
|
|
Returns the object at the end of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> without removing it.
|
|
</summary>
|
|
<returns>The object at the end of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if the buffer is empty.</exception>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Put(`0[])">
|
|
<summary>
|
|
Copies an entire compatible one-dimensional array to the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the source of the elements copied to <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if buffer does not have sufficient capacity to put in new items.</exception>
|
|
<remarks>If <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.Size"/> plus the size of <paramref name="array"/> exceeds the capacity of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> and the <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.AllowOverwrite"/> property is <c>true</c>, the oldest items in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> are overwritten with <paramref name="array"/>.</remarks>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Put(`0[],System.Int32,System.Int32)">
|
|
<summary>
|
|
Copies a range of elements from a compatible one-dimensional array to the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the source of the elements copied to <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
|
|
<param name="count">The number of elements to copy.</param>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if buffer does not have sufficient capacity to put in new items.</exception>
|
|
<remarks>If <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.Size"/> plus <paramref name="count"/> exceeds the capacity of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> and the <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.AllowOverwrite"/> property is <c>true</c>, the oldest items in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> are overwritten with <paramref name="array"/>.</remarks>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Put(`0)">
|
|
<summary>
|
|
Adds an object to the end of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<param name="item">The object to add to the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>. The value can be <c>null</c> for reference types.</param>
|
|
<exception cref="T:System.InvalidOperationException">Thrown if buffer does not have sufficient capacity to put in new items.</exception>
|
|
<remarks>If <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.Size"/> already equals the capacity and the <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.AllowOverwrite"/> property is <c>true</c>, the oldest item in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> is overwritten with <paramref name="item"/>.</remarks>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.Skip(System.Int32)">
|
|
<summary>
|
|
Increments the starting index of the data buffer in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<param name="count">The number of elements to increment the data buffer start index by.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.ToArray">
|
|
<summary>
|
|
Copies the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> elements to a new array.
|
|
</summary>
|
|
<returns>A new array containing elements copied from the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</returns>
|
|
<remarks>The <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> is not modified. The order of the elements in the new array is the same as the order of the elements from the beginning of the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> to its end.</remarks>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">
|
|
<summary>
|
|
Copies the elements of the <see cref="T:System.Collections.ICollection"/> to an <see cref="T:System.Array"/>, starting at a particular <see cref="T:System.Array"/> index.
|
|
</summary>
|
|
<param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements copied from <see cref="T:System.Collections.ICollection"/>. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
|
|
<param name="arrayIndex">The zero-based index in <paramref name="array"/> at which copying begins.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#Generic#ICollection{T}#Add(`0)">
|
|
<summary>
|
|
Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1" />.
|
|
</summary>
|
|
<param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1" />.</param>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#Generic#ICollection{T}#Remove(`0)">
|
|
<summary>
|
|
Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</summary>
|
|
<param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
|
|
<returns><c>true</c> if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, <c>false</c>. This method also returns <c>false</c> if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>.</returns>
|
|
<exception cref="T:System.NotSupportedException">Cannot remove items from collection.</exception>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#Generic#IEnumerable{T}#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through the collection.
|
|
</summary>
|
|
<returns>A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="M:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#IEnumerable#GetEnumerator">
|
|
<summary>
|
|
Returns an enumerator that iterates through a collection.
|
|
</summary>
|
|
<returns>An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection.</returns>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.AllowOverwrite">
|
|
<summary>
|
|
Gets or sets a value indicating whether the buffer will automatically overwrite the oldest items in the buffer when the maximum capacity is reached.
|
|
</summary>
|
|
<value><c>true</c> if the oldest items in the buffer are automatically overwritten when the buffer is full; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.Capacity">
|
|
<summary>
|
|
Gets or sets the total number of elements the internal data structure can hold.
|
|
</summary>
|
|
<value>The total number of elements that the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/> can contain.</value>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if the specified new capacity is smaller than the current contents of the buffer.</exception>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.Head">
|
|
<summary>
|
|
Gets the index of the beginning of the buffer data.
|
|
</summary>
|
|
<value>The index of the first element in the buffer.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.IsEmpty">
|
|
<summary>
|
|
Gets a value indicating whether the buffer is empty.
|
|
</summary>
|
|
<value><c>true</c> if buffer is empty; otherwise, <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.IsFull">
|
|
<summary>
|
|
Gets a value indicating whether the buffer is full.
|
|
</summary>
|
|
<value><c>true</c> if the buffer is full; otherwise, <c>false</c>.</value>
|
|
<remarks>The <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.IsFull"/> property always returns <c>false</c> if the <see cref="P:Cyotek.Collections.Generic.CircularBuffer`1.AllowOverwrite"/> property is set to <c>true</c>.</remarks>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.Size">
|
|
<summary>
|
|
Gets the number of elements contained in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.
|
|
</summary>
|
|
<value>The number of elements contained in the <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.Tail">
|
|
<summary>
|
|
Gets the index of the end of the buffer data.
|
|
</summary>
|
|
<value>The index of the last element in the buffer.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#ICollection#Count">
|
|
<summary>
|
|
Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
|
|
</summary>
|
|
<value>The number of elements actually contained in the <see cref="T:System.Collections.ICollection"/>.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#ICollection#IsSynchronized">
|
|
<summary>
|
|
Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread safe).
|
|
</summary>
|
|
<value><c>true</c> if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread safe); otherwise, <c>false</c>. In the default implementation of <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>, this property always returns <c>false</c>.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#ICollection#SyncRoot">
|
|
<summary>
|
|
Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
|
|
</summary>
|
|
<value>An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/></value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#Generic#ICollection{T}#Count">
|
|
<summary>
|
|
Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.
|
|
</summary>
|
|
<value>The number of elements actually contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</value>
|
|
</member>
|
|
<member name="P:Cyotek.Collections.Generic.CircularBuffer`1.System#Collections#Generic#ICollection{T}#IsReadOnly">
|
|
<summary>
|
|
Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.
|
|
</summary>
|
|
<value><c>true</c> if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, <c>false</c>. In the default implementation of <see cref="T:Cyotek.Collections.Generic.CircularBuffer`1"/>, this property always returns <c>false</c>.</value>
|
|
</member>
|
|
</members>
|
|
</doc>
|