QuantConnect.Interfaces.IBusyCollection< T > Interface Template Reference

Interface used to handle items being processed and communicate busy state More...

Inheritance diagram for QuantConnect.Interfaces.IBusyCollection< T >:

Public Member Functions
void	Add (T item)
	Adds the items to this collection More...
void	Add (T item, CancellationToken cancellationToken)
	Adds the items to this collection More...
void	CompleteAdding ()
	Marks the collection as not accepting any more additions More...
IEnumerable< T >	GetConsumingEnumerable ()
	Provides a consuming enumerable for items in this collection. More...
IEnumerable< T >	GetConsumingEnumerable (CancellationToken cancellationToken)
	Provides a consuming enumerable for items in this collection. More...

Properties
WaitHandle	WaitHandle [get]
	Gets a wait handle that can be used to wait until this instance is done processing all of it's item More...
int	Count [get]
	Gets the number of items held within this collection More...
bool	IsBusy [get]
	Returns true if processing, false otherwise More...

Detailed Description

Interface used to handle items being processed and communicate busy state

Template Parameters

T	The item type being processed

Definition at line 27 of file IBusyCollection.cs.

Member Function Documentation

Add() [1/2]

void QuantConnect.Interfaces.IBusyCollection< T >.Add

(

T

item

)

Adds the items to this collection

Parameters

item	The item to be added

Implemented in QuantConnect.Util.BusyBlockingCollection< T >, and QuantConnect.Util.BusyCollection< T >.

Add() [2/2]

void QuantConnect.Interfaces.IBusyCollection< T >.Add	(	T	item,
		CancellationToken	cancellationToken
	)

Adds the items to this collection

Parameters

item	The item to be added
cancellationToken	A cancellation token to observer

Implemented in QuantConnect.Util.BusyBlockingCollection< T >, and QuantConnect.Util.BusyCollection< T >.

CompleteAdding()

void QuantConnect.Interfaces.IBusyCollection< T >.CompleteAdding

(

)

Marks the collection as not accepting any more additions

Implemented in QuantConnect.Util.BusyCollection< T >, and QuantConnect.Util.BusyBlockingCollection< T >.

GetConsumingEnumerable() [1/2]

IEnumerable<T> QuantConnect.Interfaces.IBusyCollection< T >.GetConsumingEnumerable

(

)

Provides a consuming enumerable for items in this collection.

Returns

An enumerable that removes and returns items from the collection

Implemented in QuantConnect.Util.BusyBlockingCollection< T >, and QuantConnect.Util.BusyCollection< T >.

GetConsumingEnumerable() [2/2]

IEnumerable<T> QuantConnect.Interfaces.IBusyCollection< T >.GetConsumingEnumerable

(

CancellationToken

cancellationToken

)

Provides a consuming enumerable for items in this collection.

Parameters

cancellationToken

A cancellation token to observer

Returns

An enumerable that removes and returns items from the collection

Implemented in QuantConnect.Util.BusyBlockingCollection< T >, and QuantConnect.Util.BusyCollection< T >.

Property Documentation

WaitHandle

WaitHandle QuantConnect.Interfaces.IBusyCollection< T >.WaitHandle

get

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

Definition at line 33 of file IBusyCollection.cs.

Count

int QuantConnect.Interfaces.IBusyCollection< T >.Count

get

Gets the number of items held within this collection

Definition at line 38 of file IBusyCollection.cs.

IsBusy

bool QuantConnect.Interfaces.IBusyCollection< T >.IsBusy

get

Returns true if processing, false otherwise

Definition at line 43 of file IBusyCollection.cs.

---

The documentation for this interface was generated from the following file:

• Common/Interfaces/IBusyCollection.cs