Class BusyBlockingCollection<T>

Namespace

FinanceSharp

Assembly

FinanceSharp.dll

A small wrapper around BlockingCollection<T> used to communicate busy state of the items being processed

public class BusyBlockingCollection<T> : IBusyCollection<T>, IDisposable

Type Parameters

T

The item type being processed

Inheritance

object

BusyBlockingCollection<T>

Implements

IBusyCollection<T>

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DisposableExtensions.DisposeSafely(IDisposable)

DisposableExtensions.DisposeSafely(IDisposable, Action<Exception>)

StringExtensions.ConvertInvariant(object, Type)

StringExtensions.ConvertInvariant<T>(object)

Constructors

BusyBlockingCollection()

Initializes a new instance of the BusyBlockingCollection<T> class with a bounded capacity of MaxValue

public BusyBlockingCollection()

BusyBlockingCollection(int)

Initializes a new instance of the BusyBlockingCollection<T> class with the specified boundedCapacity

public BusyBlockingCollection(int boundedCapacity)

Parameters

boundedCapacity int

The maximum number of items allowed in the collection

Properties

Count

Gets the number of items held within this collection

public int Count { get; }

Property Value

int

IsBusy

Returns true if processing, false otherwise

public bool IsBusy { get; }

Property Value

bool

WaitHandle

Gets a wait handle that can be used to wait until this instance is done processing all of it's item

public WaitHandle WaitHandle { get; }

Property Value

WaitHandle

Methods

Add(T)

Adds the items to this collection

public void Add(T item)

Parameters

item T

The item to be added

Add(T, CancellationToken)

Adds the items to this collection

public void Add(T item, CancellationToken cancellationToken)

Parameters

item T

The item to be added

cancellationToken CancellationToken

A cancellation token to observer

CompleteAdding()

Marks the BusyBlockingCollection<T> as not accepting any more additions

public void CompleteAdding()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetConsumingEnumerable()

Provides a consuming enumerable for items in this collection.

public IEnumerable<T> GetConsumingEnumerable()

Returns

IEnumerable<T>

An enumerable that removes and returns items from the collection

GetConsumingEnumerable(CancellationToken)

Provides a consuming enumerable for items in this collection.

public IEnumerable<T> GetConsumingEnumerable(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

A cancellation token to observer

Returns

IEnumerable<T>

An enumerable that removes and returns items from the collection