JoinBlock<T1,T2>.TryReceive Method

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Source:

JoinBlock.cs

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

public:
 virtual bool TryReceive(Predicate<Tuple<T1, T2> ^> ^ filter, [Runtime::InteropServices::Out] Tuple<T1, T2> ^ % item);

public bool TryReceive (Predicate<Tuple<T1,T2>>? filter, out Tuple<T1,T2>? item);

abstract member TryReceive : Predicate<'T1 * 'T2> * Tuple -> bool
override this.TryReceive : Predicate<'T1 * 'T2> * Tuple -> bool

Public Function TryReceive (filter As Predicate(Of Tuple(Of T1, T2)), ByRef item As Tuple(Of T1, T2)) As Boolean

Parameters

filter

Predicate<Tuple<T1,T2>>

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

item

Tuple<T1,T2>

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.