BatchedJoinBlock<T1,T2>
Class
Definition
Provides a dataflow block that batches a specified number of inputs of potentially differing types provided to one or more of its targets.
public sealed class BatchedJoinBlock<T1,T2> : System.Threading.Tasks.Dataflow.IReceivableSourceBlock<Tuple<System.Collections.Generic.IList<T1>,System.Collections.Generic.IList<T2>>>, System.Threading.Tasks.Dataflow.ISourceBlock<Tuple<System.Collections.Generic.IList<T1>,System.Collections.Generic.IList<T2>>>
- 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.
- Inheritance
-
BatchedJoinBlock<T1,T2>
- Implements
-
IReceivableSourceBlock<Tuple<IList<T1>,IList<T2>>> ISourceBlock<Tuple<IList<T1>,IList<T2>>>
Inherited Members
System.Object
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.
Constructors
| BatchedJoinBlock<T1,T2>(Int32) |
Initializes a new BatchedJoinBlock<T1,T2> with the specified configuration. |
| BatchedJoinBlock<T1,T2>(Int32, GroupingDataflowBlockOptions) |
Initializes a new BatchedJoinBlock<T1,T2> with the specified configuration. |
Properties
| BatchSize |
Gets the size of the batches generated by this BatchedJoinBlock<T1,T2>. |
| 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. |
Methods
| Complete() |
Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages. |
| LinkTo(ITargetBlock<Tuple<IList<T1>,IList<T2>>>, DataflowLinkOptions) |
Links the ISourceBlock<TOutput> to the specified ITargetBlock<TInput> . |
| ToString() |
Returns a string that represents the formatted name of this IDataflowBlock instance. |
| TryReceive(Predicate<Tuple<IList<T1>,IList<T2>>>, Tuple<IList<T1>,IList<T2>>) |
Attempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>. |
| TryReceiveAll(IList<Tuple<IList<T1>,IList<T2>>>) |
Attempts to synchronously receive all available items from the IReceivableSourceBlock<TOutput>. |