BatchBlock<T>.TryReceive(Predicate<T[]>, T[]) Method

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Package:

System.Threading.Tasks.Dataflow v9.0.0-rc.2.24473.5

Source:

BatchBlock.cs

Attempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>.

public:
 virtual bool TryReceive(Predicate<cli::array <T> ^> ^ filter, [Runtime::InteropServices::Out] cli::array <T> ^ % item);

public bool TryReceive (Predicate<T[]>? filter, out T[]? item);

abstract member TryReceive : Predicate<'T[]> * T[] -> bool
override this.TryReceive : Predicate<'T[]> * T[] -> bool

Public Function TryReceive (filter As Predicate(Of T()), ByRef item As T()) As Boolean

Parameters

filter

Predicate<T[]>

The predicate a value must successfully pass in order for it to be received. filter may be null, in which case all items will pass.

item

T[]

The item received from the source.

Returns

Boolean

true if an item could be received; otherwise, false.

Remarks

This method does not block waiting for the source to provide an item.

It will return after checking for an element, whether or not an element was available.