1063 lines
59 KiB
XML
1063 lines
59 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Type Name="BlockingCollection<T>" FullName="System.Collections.Concurrent.BlockingCollection<T>">
|
||
<TypeSignature Language="C#" Value="public class BlockingCollection<T> : IDisposable, System.Collections.Generic.IEnumerable<T>, System.Collections.ICollection" />
|
||
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit BlockingCollection`1<T> extends System.Object implements class System.Collections.Generic.IEnumerable`1<!T>, class System.Collections.ICollection, class System.Collections.IEnumerable, class System.IDisposable" />
|
||
<AssemblyInfo>
|
||
<AssemblyName>System</AssemblyName>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<TypeParameters>
|
||
<TypeParameter Name="T" />
|
||
</TypeParameters>
|
||
<Base>
|
||
<BaseTypeName>System.Object</BaseTypeName>
|
||
</Base>
|
||
<Interfaces>
|
||
<Interface>
|
||
<InterfaceName>System.Collections.Generic.IEnumerable<T></InterfaceName>
|
||
</Interface>
|
||
<Interface>
|
||
<InterfaceName>System.Collections.ICollection</InterfaceName>
|
||
</Interface>
|
||
<Interface>
|
||
<InterfaceName>System.IDisposable</InterfaceName>
|
||
</Interface>
|
||
</Interfaces>
|
||
<Attributes>
|
||
<Attribute>
|
||
<AttributeName>System.Diagnostics.DebuggerDisplay("Count={Count}")</AttributeName>
|
||
</Attribute>
|
||
<Attribute>
|
||
<AttributeName>System.Diagnostics.DebuggerTypeProxy(typeof(System.Collections.Generic.CollectionDebuggerView`1))</AttributeName>
|
||
</Attribute>
|
||
<Attribute>
|
||
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
|
||
</Attribute>
|
||
</Attributes>
|
||
<Docs>
|
||
<typeparam name="T">To be added.</typeparam>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>
|
||
<see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is a thread-safe collection class that provides the following:</para>
|
||
<list type="bullet">
|
||
<item>
|
||
<para>An implementation of the producer/consumer pattern; <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is a wrapper for the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> interface.</para>
|
||
</item>
|
||
<item>
|
||
<para>Concurrent addition and removal of items from multiple threads with the <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0)" /> and <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Take" /> methods.</para>
|
||
</item>
|
||
<item>
|
||
<para>A bounded collection that blocks <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0)" /> and <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Take" /> operations when the collection is full or empty.</para>
|
||
</item>
|
||
<item>
|
||
<para>Cancellation of <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0)" /> or <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Take" /> operations by using a <see cref="T:System.Threading.CancellationToken" /> object in the <see cref="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0)" /> or <see cref="M:System.Collections.Concurrent.BlockingCollection`1.TryTake(`0@)" /> method.</para>
|
||
</item>
|
||
</list>
|
||
<para>
|
||
<see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> represents a collection that allows for thread-safe adding and removal of data. <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is used as a wrapper for an <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> instance, and allows removal attempts from the collection to block until data is available to be removed. Similarly, you can create a <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> to enforce an upper bound on the number of data elements allowed in the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />; addition attempts to the collection may then block until space is available to store the added items. In this manner, <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is similar to a traditional blocking queue data structure, except that the underlying data storage mechanism is abstracted away as an <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</para>
|
||
<para>
|
||
<see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> supports bounding and blocking. Bounding means that you can set the maximum capacity of the collection. Bounding is important in certain scenarios because it enables you to control the maximum size of the collection in memory, and it prevents the producing threads from moving too far ahead of the consuming threads.Multiple threads or tasks can add items to the collection concurrently, and if the collection reaches its specified maximum capacity, the producing threads will block until an item is removed. Multiple consumers can remove items concurrently, and if the collection becomes empty, the consuming threads will block until a producer adds an item. A producing thread can call the <see cref="M:System.Collections.Concurrent.BlockingCollection`1.CompleteAdding" /> method to indicate that no more items will be added. Consumers monitor the <see cref="P:System.Collections.Concurrent.BlockingCollection`1.IsCompleted" /> property to know when the collection is empty and no more items will be added. </para>
|
||
<para>
|
||
<see cref="M:System.Collections.Concurrent.BlockingCollection`1.Add(`0)" /> and <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Take" /> operations are typically performed in a loop. You can cancel a loop by passing in a <see cref="T:System.Threading.CancellationToken" /> object to the <see cref="M:System.Collections.Concurrent.BlockingCollection`1.TryAdd(`0)" /> or <see cref="M:System.Collections.Concurrent.BlockingCollection`1.TryTake(`0@)" /> method, and then checking the value of the token's <see cref="P:System.Threading.CancellationToken.IsCancellationRequested" /> property on each iteration. If the value is true, it is up to you to respond the cancellation request by cleaning up any resources and exiting the loop.</para>
|
||
<para>When you create a <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> object, you can specify not only the bounded capacity but also the type of collection to use. For example, you could specify a <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> object for first in, first out (FIFO) behavior, or a <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> object for last in, first out (LIFO) behavior. You can use any collection class that implements the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> interface. The default collection type for <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</para>
|
||
<para>Do not modify the underlying collection directly. Use <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> methods to add or remove elements. The <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> object can become corrupted if you change the underlying collection directly.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Provides blocking and bounding capabilities for thread-safe collections that implement <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" />.</para>
|
||
</summary>
|
||
</Docs>
|
||
<Members>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public BlockingCollection ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The default underlying collection is a <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" /> object, which provides first in, first out (FIFO) behavior.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class without an upper-bound.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public BlockingCollection (System.Collections.Concurrent.IProducerConsumerCollection<T> collection);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Concurrent.IProducerConsumerCollection`1<!T> collection) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="collection" Type="System.Collections.Concurrent.IProducerConsumerCollection<T>" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collection">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public BlockingCollection (int boundedCapacity);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 boundedCapacity) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="boundedCapacity" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The default underlying collection is a <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class with the specified upper-bound.</para>
|
||
</summary>
|
||
<param name="boundedCapacity">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The bounded size of the collection.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public BlockingCollection (System.Collections.Concurrent.IProducerConsumerCollection<T> collection, int boundedCapacity);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Concurrent.IProducerConsumerCollection`1<!T> collection, int32 boundedCapacity) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="collection" Type="System.Collections.Concurrent.IProducerConsumerCollection<T>" />
|
||
<Parameter Name="boundedCapacity" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collection">To be added.</param>
|
||
<param name="boundedCapacity">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Add">
|
||
<MemberSignature Language="C#" Value="public void Add (T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(!T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Add">
|
||
<MemberSignature Language="C#" Value="public void Add (T item, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Add(!T item, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="AddToAny">
|
||
<MemberSignature Language="C#" Value="public static int AddToAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 AddToAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="AddToAny">
|
||
<MemberSignature Language="C#" Value="public static int AddToAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, T item, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 AddToAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="BoundedCapacity">
|
||
<MemberSignature Language="C#" Value="public int BoundedCapacity { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance int32 BoundedCapacity" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the bounded capacity of this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CompleteAdding">
|
||
<MemberSignature Language="C#" Value="public void CompleteAdding ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CompleteAdding() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>After a collection has been marked as complete for adding, adding to the collection is not permitted and attempts to remove from the collection will not wait when the collection is empty.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Marks the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instances as not accepting any more additions.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CopyTo">
|
||
<MemberSignature Language="C#" Value="public void CopyTo (T[] array, int index);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyTo(!T[] array, int32 index) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="array" Type="T[]" />
|
||
<Parameter Name="index" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="array">To be added.</param>
|
||
<param name="index">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Count">
|
||
<MemberSignature Language="C#" Value="public int Count { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>If any method in BlockingCollection is executing while the Count property is being accessd, the return value is approximate. Count may reflect a number that is either greater than or less than the actual number of items in the BlockingCollection.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the number of items contained in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Dispose">
|
||
<MemberSignature Language="C#" Value="public void Dispose ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The Dispose method is not thread-safe.</para>
|
||
<para>Call Dispose when you are finished using the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />. The Dispose method leaves the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> in an unusable state. After calling Dispose, you must release all references to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> so the garbage collector can reclaim the memory that the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> was occupying.</para>
|
||
<para>For more information, see <format type="text/html"><a href="A17B0066-71C2-4BA4-9822-8E19332FC213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>.</para>
|
||
<block subset="none" type="note">
|
||
<para>Always call Dispose before you release your last reference to the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> object's Finalize method.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Releases all resources used by the current instance of the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> class.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Dispose">
|
||
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
|
||
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="disposing" Type="System.Boolean" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Releases resources used by the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance.</para>
|
||
</summary>
|
||
<param name="disposing">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />Whether being disposed explicitly (true) or due to a finalizer (false).</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="GetConsumingEnumerable">
|
||
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<T> GetConsumingEnumerable ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<!T> GetConsumingEnumerable() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Collections.Generic.IEnumerable<T></ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Provides a consuming <see cref="T:System.Collections.Generic.IEnumerator`1" /> for items in the collection.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> that removes and returns items from the collection.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="GetConsumingEnumerable">
|
||
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<T> GetConsumingEnumerable (System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IEnumerable`1<!T> GetConsumingEnumerable(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Collections.Generic.IEnumerable<T></ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>This method enables client code to remove items from the collection by using a foreach loop (For Each in Visual Basic), or <see cref="M:System.Threading.Tasks.Parallel.ForEach``1(System.Collections.Concurrent.Partitioner{``0},System.Action{``0})" /> or a PLINQ query. The enumerator will continue to provide items (if any exist) until <see cref="P:System.Collections.Concurrent.BlockingCollection`1.IsCompleted" /> returns true, and if <see cref="P:System.Collections.Concurrent.BlockingCollection`1.IsCompleted" /> is false the loop blocks until an item becomes available or until the <see cref="T:System.Threading.CancellationToken" /> is cancelled. </para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Provides a consuming <see cref="T:System.Collections.Generic.IEnumerable`1" /> for items in the collection.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>An <see cref="T:System.Collections.Generic.IEnumerable`1" /> that removes and returns items from the collection.</para>
|
||
</returns>
|
||
<param name="cancellationToken">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />A cancellation token to observe.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="IsAddingCompleted">
|
||
<MemberSignature Language="C#" Value="public bool IsAddingCompleted { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance bool IsAddingCompleted" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets whether this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete for adding.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="IsCompleted">
|
||
<MemberSignature Language="C#" Value="public bool IsCompleted { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance bool IsCompleted" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets whether this <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> has been marked as complete for adding and is empty.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="System.Collections.Generic.IEnumerable<T>.GetEnumerator">
|
||
<MemberSignature Language="C#" Value="System.Collections.Generic.IEnumerator<T> IEnumerable<T>.GetEnumerator ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.Generic.IEnumerator`1<!T> System.Collections.Generic.IEnumerable<T>.GetEnumerator() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Collections.Generic.IEnumerator<T></ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="System.Collections.ICollection.CopyTo">
|
||
<MemberSignature Language="C#" Value="void ICollection.CopyTo (Array array, int index);" />
|
||
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Collections.ICollection.CopyTo(class System.Array array, int32 index) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="array" Type="System.Array" />
|
||
<Parameter Name="index" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Copies all of the items in the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance to a compatible one-dimensional array, starting at the specified index of the target array.</para>
|
||
</summary>
|
||
<param name="array">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The one-dimensional array that is the destination of the elements copied from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance. The array must have zero-based indexing.</param>
|
||
<param name="index">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The zero-based index in <paramref name="array" /> at which copying begins.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="System.Collections.ICollection.IsSynchronized">
|
||
<MemberSignature Language="C#" Value="bool System.Collections.ICollection.IsSynchronized { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance bool System.Collections.ICollection.IsSynchronized" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection" /> is synchronized.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="System.Collections.ICollection.SyncRoot">
|
||
<MemberSignature Language="C#" Value="object System.Collections.ICollection.SyncRoot { get; }" />
|
||
<MemberSignature Language="ILAsm" Value=".property instance object System.Collections.ICollection.SyncRoot" />
|
||
<MemberType>Property</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Object</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection" />. This property is not supported.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">
|
||
<MemberSignature Language="C#" Value="System.Collections.IEnumerator IEnumerable.GetEnumerator ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Collections.IEnumerator</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Provides an <see cref="T:System.Collections.IEnumerator" /> for items in the collection.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>An <see cref="T:System.Collections.IEnumerator" /> for the items in the collection.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Take">
|
||
<MemberSignature Language="C#" Value="public T Take ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !T Take() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>T</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A call to <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Take" /> may block until an item is available to be removed.</para>
|
||
<para>The order in which an item is removed depends on the type of collection used to create the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance. When you create a <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> object, you can specify the type of collection to use. For example, you could specify a <see cref="T:System.Collections.ConcurrentConcurrentQueue`1" /> object for first in, first out (FIFO) behavior, or a <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> object for last in, first out (LIFO) behavior. You can use any collection class that implements the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> interface. The default collection type for <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The item removed from the collection.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Take">
|
||
<MemberSignature Language="C#" Value="public T Take (System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !T Take(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>T</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A call to <see cref="M:System.Collections.Concurrent.BlockingCollection`1.Take(System.Threading.CancellationToken)" /> may block until an item is available to be removed or the token is canceled.</para>
|
||
<para>The order in which an item is removed depends on the type of collection used to create the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance. When you create a <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> object, you can specify the type of collection to use. For example, you could specify a <see cref="T:System.Collections.ConcurrentConcurrentQueue`1" /> object for first in, first out (FIFO) behavior, or a <see cref="T:System.Collections.Concurrent.ConcurrentStack`1" /> object for last in, first out (LIFO) behavior. You can use any collection class that implements the <see cref="T:System.Collections.Concurrent.IProducerConsumerCollection`1" /> interface. The default collection type for <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> is <see cref="T:System.Collections.Concurrent.ConcurrentQueue`1" />.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Removes an item from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" />.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The item removed from the collection.</para>
|
||
</returns>
|
||
<param name="cancellationToken">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />Object that can be used to cancel the take operation.</param>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TakeFromAny">
|
||
<MemberSignature Language="C#" Value="public static int TakeFromAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TakeFromAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TakeFromAny">
|
||
<MemberSignature Language="C#" Value="public static int TakeFromAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TakeFromAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="ToArray">
|
||
<MemberSignature Language="C#" Value="public T[] ToArray ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !T[] ToArray() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>T[]</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The copied elements are not removed from the collection. </para>
|
||
<para>If any method in BlockingCollection is executing while the ToArray method executes, the return value is approximate. ToArray may include items that have already been removed, or exclude items that have already been inserted.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Copies the items from the <see cref="T:System.Collections.Concurrent.BlockingCollection`1" /> instance into a new array.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>An array containing copies of the elements of the collection.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAdd">
|
||
<MemberSignature Language="C#" Value="public bool TryAdd (T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryAdd(!T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAdd">
|
||
<MemberSignature Language="C#" Value="public bool TryAdd (T item, int millisecondsTimeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryAdd(!T item, int32 millisecondsTimeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAdd">
|
||
<MemberSignature Language="C#" Value="public bool TryAdd (T item, TimeSpan timeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryAdd(!T item, valuetype System.TimeSpan timeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="timeout" Type="System.TimeSpan" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="timeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAdd">
|
||
<MemberSignature Language="C#" Value="public bool TryAdd (T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryAdd(!T item, int32 millisecondsTimeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAddToAny">
|
||
<MemberSignature Language="C#" Value="public static int TryAddToAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryAddToAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAddToAny">
|
||
<MemberSignature Language="C#" Value="public static int TryAddToAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, T item, int millisecondsTimeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryAddToAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, int32 millisecondsTimeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAddToAny">
|
||
<MemberSignature Language="C#" Value="public static int TryAddToAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, T item, TimeSpan timeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryAddToAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, valuetype System.TimeSpan timeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="timeout" Type="System.TimeSpan" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="timeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryAddToAny">
|
||
<MemberSignature Language="C#" Value="public static int TryAddToAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryAddToAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, int32 millisecondsTimeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTake">
|
||
<MemberSignature Language="C#" Value="public bool TryTake (out T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryTake(!T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTake">
|
||
<MemberSignature Language="C#" Value="public bool TryTake (out T item, int millisecondsTimeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryTake(!T item, int32 millisecondsTimeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTake">
|
||
<MemberSignature Language="C#" Value="public bool TryTake (out T item, TimeSpan timeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryTake(!T item, valuetype System.TimeSpan timeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="timeout" Type="System.TimeSpan" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="timeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTake">
|
||
<MemberSignature Language="C#" Value="public bool TryTake (out T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryTake(!T item, int32 millisecondsTimeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTakeFromAny">
|
||
<MemberSignature Language="C#" Value="public static int TryTakeFromAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryTakeFromAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTakeFromAny">
|
||
<MemberSignature Language="C#" Value="public static int TryTakeFromAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, int millisecondsTimeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryTakeFromAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, int32 millisecondsTimeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTakeFromAny">
|
||
<MemberSignature Language="C#" Value="public static int TryTakeFromAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, TimeSpan timeout);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryTakeFromAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, valuetype System.TimeSpan timeout) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="timeout" Type="System.TimeSpan" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="timeout">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="TryTakeFromAny">
|
||
<MemberSignature Language="C#" Value="public static int TryTakeFromAny (System.Collections.Concurrent.BlockingCollection<T>[] collections, out T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 TryTakeFromAny(class System.Collections.Concurrent.BlockingCollection`1<!T>[] collections, !T item, int32 millisecondsTimeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters>
|
||
<Parameter Name="collections" Type="System.Collections.Concurrent.BlockingCollection<T>[]" />
|
||
<Parameter Name="item" Type="T&" RefType="out" />
|
||
<Parameter Name="millisecondsTimeout" Type="System.Int32" />
|
||
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="collections">To be added.</param>
|
||
<param name="item">To be added.</param>
|
||
<param name="millisecondsTimeout">To be added.</param>
|
||
<param name="cancellationToken">To be added.</param>
|
||
<summary>To be added.</summary>
|
||
<returns>To be added.</returns>
|
||
<remarks>To be added.</remarks>
|
||
</Docs>
|
||
</Member>
|
||
</Members>
|
||
</Type> |