</Base>
<Interfaces />
<Docs>
- <typeparam name="T">To be added.</typeparam>
- <summary>To be added.</summary>
- <remarks>To be added.</remarks>
+ <typeparam name="T">The type of elements in the list.</typeparam>
+ <summary>Provide a concurrent thread-safe implementation of a linked-list that keeps elements in order.</summary>
+ <remarks>This collection doesn't support duplicate elements with the same hash.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
</AssemblyInfo>
<Parameters />
<Docs>
- <summary>To be added.</summary>
+ <summary>Initialize a new instance of ConcurrentOrderedList that is empty and use a default equality comparer.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Parameter Name="comparer" Type="System.Collections.Generic.IEqualityComparer<T>" />
</Parameters>
<Docs>
- <param name="comparer">To be added.</param>
+ <param name="comparer">Comparer used to determine elements hash and equality.</param>
+ <summary>Initialize a new instance of ConcurrentOrderedList that is empty and use a provided equality comparer.</summary>
+ <remarks />
+ </Docs>
+ </Member>
+ <Member MemberName="Comparer">
+ <MemberSignature Language="C#" Value="public System.Collections.Generic.IEqualityComparer<T> Comparer { get; }" />
+ <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEqualityComparer`1<!T> Comparer" />
+ <MemberType>Property</MemberType>
+ <AssemblyInfo>
+ <AssemblyVersion>4.0.0.0</AssemblyVersion>
+ </AssemblyInfo>
+ <ReturnValue>
+ <ReturnType>System.Collections.Generic.IEqualityComparer<T></ReturnType>
+ </ReturnValue>
+ <Docs>
<summary>To be added.</summary>
+ <value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Parameter Name="data" Type="T" />
</Parameters>
<Docs>
- <param name="data">To be added.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <param name="data">The data to locate in the list.</param>
+ <summary>Checks if the supplied element is in the ConcurrentOrderedList.</summary>
+ <returns>true if the item is found, false otherwise.</returns>
+ <remarks />
</Docs>
</Member>
<Member MemberName="ContainsHash">
<Parameter Name="key" Type="System.Int32" />
</Parameters>
<Docs>
- <param name="key">To be added.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <param name="key">Hash value to check.</param>
+ <summary>Checks if the supplied hash corresponds to an element in the ConcurrentOrderedList.</summary>
+ <returns>true if an item corresponding to the given hash is found, false otherwise.</returns>
+ <remarks>A call to <see cref="M:ConcurrentOrderedList<T>.Contains()" /> is equivalent to calling this method using the <see cref="T:System.Collections.Generic.IEqualityComparer<T>.GetHashCode(T)" /> method with <see cref="P:ConcurrentOrderedList<T>.Comparer" />.</remarks>
</Docs>
</Member>
<Member MemberName="TryAdd">
<Parameter Name="data" Type="T" />
</Parameters>
<Docs>
- <param name="data">To be added.</param>
- <summary>To be added.</summary>
- <returns>To be added.</returns>
- <remarks>To be added.</remarks>
+ <param name="data">Data to add in the collection.</param>
+ <summary>Try to add an element to the collection.</summary>
+ <returns>True if the insertion was successful, false otherwise.</returns>
+ <remarks>This method add the supplied element only if there is no other element with an identical hash already in the list.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetFromHash">