The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

BatchedJoinBlock<T1, T2, T3> Class

Provides a dataflow block that batches a specified number of inputs of potentially differing types provided to one or more of its targets.

Namespace: System.Threading.Tasks.Dataflow
Assembly: System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)

Inheritance Hierarchy

System::Object
System.Threading.Tasks.Dataflow::BatchedJoinBlock<T1, T2, T3>

Syntax

C++

generic<typename T1, typename T2, typename T3>
public ref class BatchedJoinBlock sealed : IReceivableSourceBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>, 
	ISourceBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>, IDataflowBlock

Type Parameters

T1: Specifies the type of data accepted by the block's first target.

T2: Specifies the type of data accepted by the block's second target.

T3: Specifies the type of data accepted by the block's third target.

Constructors

	Name	Description
	BatchedJoinBlock<T1, T2, T3>(Int32)	Initializes a new BatchedJoinBlock<T1, T2, T3> with the specified configuration.
	BatchedJoinBlock<T1, T2, T3>(Int32, GroupingDataflowBlockOptions^)	Initializes a new BatchedJoinBlock<T1, T2, T3> with the specified configuration.

Properties

	Name	Description
	BatchSize	Gets the size of the batches generated by this BatchedJoinBlock<T1, T2, T3>.
	Completion	Gets a Task that represents the asynchronous operation and completion of the dataflow block.
	OutputCount	Gets the number of output items available to be received from this block.
	Target1	Gets a target that may be used to offer messages of the first type.
	Target2	Gets a target that may be used to offer messages of the second type.
	Target3	Gets a target that may be used to offer messages of the third type.

Methods

	Name	Description
	Complete()	Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages.
	Equals(Object^)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	LinkTo(ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^, DataflowLinkOptions^)	Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> .
	ToString()	Returns a string that represents the formatted name of this IDataflowBlock instance. (Overrides Object::ToString().)
	TryReceive(Predicate<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^, Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^)	Attempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>.
	TryReceiveAll(IList<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^)	Attempts to synchronously receive all available items from the IReceivableSourceBlock<TOutput>.

Explicit Interface Implementations

	Name	Description
	IDataflowBlock::Fault(Exception^)	Causes the IDataflowBlock to complete in a Faulted state.
	ISourceBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>::ConsumeMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^, Boolean)	Called by a linked ITargetBlock<TInput> to accept and consume a DataflowMessageHeader previously offered by this ISourceBlock<TOutput>.
	ISourceBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>::ReleaseReservation(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^)	Called by a linked ITargetBlock<TInput> to release a previously reserved DataflowMessageHeader by this ISourceBlock<TOutput>.
	ISourceBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>::ReserveMessage(DataflowMessageHeader, ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^)	Called by a linked ITargetBlock<TInput> to reserve a previously offered DataflowMessageHeader by this ISourceBlock<TOutput>.

Extension Methods

	Name	Description
	AsObservable<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>()	Creates a new IObservable<T> abstraction over the ISourceBlock<TOutput>.(Defined by DataflowBlock.)
	LinkTo<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^)	Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput>. (Defined by DataflowBlock.)
	LinkTo<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^, DataflowLinkOptions^, Predicate<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^)	Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. (Defined by DataflowBlock.)
	LinkTo<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(ITargetBlock<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^, Predicate<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>^)	Overloaded. Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> using the specified filter. (Defined by DataflowBlock.)
	OutputAvailableAsync<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>()	Overloaded. Provides a Task<TResult> that asynchronously monitors the source for available output.(Defined by DataflowBlock.)
	OutputAvailableAsync<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(CancellationToken)	Overloaded. Provides a Task<TResult> that asynchronously monitors the source for available output. (Defined by DataflowBlock.)
	Receive<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>()	Overloaded. Synchronously receives a value from a specified source.(Defined by DataflowBlock.)
	Receive<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(CancellationToken)	Overloaded. Synchronously receives a value from a specified source and provides a token to cancel the operation. (Defined by DataflowBlock.)
	Receive<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(TimeSpan)	Overloaded. Synchronously receives a value from a specified source, observing an optional time-out period.(Defined by DataflowBlock.)
	Receive<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(TimeSpan, CancellationToken)	Overloaded. Synchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval. (Defined by DataflowBlock.)
	ReceiveAsync<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>()	Overloaded. Asynchronously receives a value from a specified source.(Defined by DataflowBlock.)
	ReceiveAsync<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(CancellationToken)	Overloaded. Asynchronously receives a value from a specified source and provides a token to cancel the operation. (Defined by DataflowBlock.)
	ReceiveAsync<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(TimeSpan)	Overloaded. Asynchronously receives a value from a specified source, observing an optional time-out period.(Defined by DataflowBlock.)
	ReceiveAsync<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(TimeSpan, CancellationToken)	Overloaded. Asynchronously receives a value from a specified source, providing a token to cancel the operation and observing an optional time-out interval. (Defined by DataflowBlock.)
	TryReceive<Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^>(Tuple<IList<T1>^, IList<T2>^, IList<T3>^>^)	Attempts to synchronously receive an item from the ISourceBlock<TOutput>.(Defined by DataflowBlock.)

Remarks

Note
The TPL Dataflow Library (System.Threading.Tasks.Dataflow namespace) is not distributed with the .NET Framework 4.5. To install the System.Threading.Tasks.Dataflow namespace, open your project in Visual Studio 2012, choose Manage NuGet Packages from the Project menu, and search online for the Microsoft.Tpl.Dataflow package.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Deutsch	English	Español	Français
Italiano	日本語	한국어	Português
Pусский	简体中文	繁體中文