class BlockingCollection<T>
in global :: System . Collections . Concurrent
Provides blocking and bounding capabilities for thread-safe collections that implement .
TThe type of elements in the collection.
public BlockingCollection<T>( int boundedCapacity )
Initializes a new instance of the class with the specified upper-bound.
boundedCapacityThe bounded size of the collection.
public int BoundedCapacity { get; }
Gets the bounded capacity of this instance.
- Returns The bounded capacity of this collection, or int.MaxValue if no bound was supplied.
public int Count { get; }
Gets the number of items contained in the .
- Returns The number of items contained in the .
public IEnumerable<T> GetConsumingEnumerable( CancellationToken cancellationToken )
Provides a consuming for items in the collection.
cancellationTokenA cancellation token to observe.- Returns An that removes and returns items from the collection.
public bool IsAddingCompleted { get; }
Gets whether this has been marked as complete for adding.
- Returns Whether this collection has been marked as complete for adding.
public bool IsCompleted { get; }
Gets whether this has been marked as complete for adding and is empty.
- Returns Whether this collection has been marked as complete for adding and is empty.
public T Take( CancellationToken cancellationToken )
Removes an item from the .
cancellationTokenObject that can be used to cancel the take operation.- Returns The item removed from the collection.
public static int TryTakeFromAny( BlockingCollection<T>[] collections, ref T item, TimeSpan timeout )
😔 No documentation found.
public static int TryTakeFromAny( BlockingCollection<T>[] collections, ref T item, int millisecondsTimeout )
😔 No documentation found.
public static int TryTakeFromAny( BlockingCollection<T>[] collections, ref T item, int millisecondsTimeout, CancellationToken cancellationToken )
😔 No documentation found.
public void CompleteAdding( )
😔 No documentation found.
public void Dispose( )
😔 No documentation found.
public T[] ToArray( )
😔 No documentation found.
public static int TakeFromAny( BlockingCollection<T>[] collections, ref T item, CancellationToken cancellationToken )
😔 No documentation found.
public static int TryTakeFromAny( BlockingCollection<T>[] collections, ref T item )
😔 No documentation found.
public Type GetType( )
😔 No documentation found.
public string ToString( )
😔 No documentation found.
public bool Equals( object obj )
😔 No documentation found.
public int GetHashCode( )
😔 No documentation found.
public BlockingCollection<T>( )
😔 No documentation found.
public void CopyTo( T[] array, int index )
😔 No documentation found.
public IEnumerable<T> GetConsumingEnumerable( )
😔 No documentation found.
public BlockingCollection<T>( IProducerConsumerCollection<T> collection )
😔 No documentation found.
public static int TryAddToAny( BlockingCollection<T>[] collections, T item, int millisecondsTimeout )
😔 No documentation found.
public void Add( T item )
😔 No documentation found.
public void Add( T item, CancellationToken cancellationToken )
😔 No documentation found.
public bool TryAdd( T item )
😔 No documentation found.
public bool TryAdd( T item, TimeSpan timeout )
😔 No documentation found.
public bool TryAdd( T item, int millisecondsTimeout )
😔 No documentation found.
public bool TryAdd( T item, int millisecondsTimeout, CancellationToken cancellationToken )
😔 No documentation found.
public T Take( )
😔 No documentation found.
public static int TakeFromAny( BlockingCollection<T>[] collections, ref T item )
😔 No documentation found.
public bool TryTake( ref T item )
😔 No documentation found.
public bool TryTake( ref T item, int millisecondsTimeout )
😔 No documentation found.
public bool TryTake( ref T item, int millisecondsTimeout, CancellationToken cancellationToken )
😔 No documentation found.
public static int AddToAny( BlockingCollection<T>[] collections, T item )
😔 No documentation found.
public static int AddToAny( BlockingCollection<T>[] collections, T item, CancellationToken cancellationToken )
😔 No documentation found.
public static int TryAddToAny( BlockingCollection<T>[] collections, T item )
😔 No documentation found.
public static int TryAddToAny( BlockingCollection<T>[] collections, T item, TimeSpan timeout )
😔 No documentation found.
public BlockingCollection<T>( IProducerConsumerCollection<T> collection, int boundedCapacity )
😔 No documentation found.
public bool TryTake( ref T item, TimeSpan timeout )
😔 No documentation found.
public static int TryAddToAny( BlockingCollection<T>[] collections, T item, int millisecondsTimeout, CancellationToken cancellationToken )
😔 No documentation found.