TransformManyBlock<TInput,TOutput>
Class
Definition
Provides a dataflow block that invokes a provided Func<T,TResult> delegate for every data element received.
public sealed class TransformManyBlock<TInput,TOutput> : System.Threading.Tasks.Dataflow.IPropagatorBlock<TInput,TOutput>, System.Threading.Tasks.Dataflow.IReceivableSourceBlock<TOutput>, System.Threading.Tasks.Dataflow.ISourceBlock<TOutput>, System.Threading.Tasks.Dataflow.ITargetBlock<TInput>
- TInput
Specifies the type of data received and operated on by this TransformManyBlock<TInput,TOutput>.
- TOutput
Specifies the type of data output by this TransformManyBlock<TInput,TOutput>.
- Inheritance
-
TransformManyBlock<TInput,TOutput>
- Implements
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
| TransformManyBlock<TInput,TOutput>(Func<TInput,IEnumerable<TOutput>>) |
Initializes a new TransformManyBlock<TInput,TOutput> with the specified function. |
| TransformManyBlock<TInput,TOutput>(Func<TInput,Task<IEnumerable<TOutput>>>) |
Initializes a new TransformManyBlock<TInput,TOutput> with the specified function. |
| TransformManyBlock<TInput,TOutput>(Func<TInput,IEnumerable<TOutput>>, ExecutionDataflowBlockOptions) |
Initializes a new TransformManyBlock<TInput,TOutput> with the specified function and ExecutionDataflowBlockOptions. |
| TransformManyBlock<TInput,TOutput>(Func<TInput,Task<IEnumerable<TOutput>>>, ExecutionDataflowBlockOptions) |
Initializes a new TransformManyBlock<TInput,TOutput> with the specified function and ExecutionDataflowBlockOptions. |
Properties
| Completion |
Gets a Task that represents the asynchronous operation and completion of the dataflow block. |
| InputCount |
Gets the number of input items waiting to be processed by this block. |
| OutputCount |
Gets the number of output items available to be received from this block. |
Methods
| Complete() |
Signals to the IDataflowBlock that it should not accept nor produce any more messages nor consume any more postponed messages. |
| LinkTo(ITargetBlock<TOutput>, 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<TOutput>, TOutput) |
Attempts to synchronously receive an available output item from the IReceivableSourceBlock<TOutput>. |
| TryReceiveAll(IList<TOutput>) |
Attempts to synchronously receive all available items from the IReceivableSourceBlock<TOutput>. |
Explicit Interface Implementations
| IDataflowBlock.Fault(Exception) |
Causes the IDataflowBlock to complete in a Faulted state. |
| ISourceBlock<TOutput>.ConsumeMessage(DataflowMessageHeader, ITargetBlock<TOutput>, Boolean) |
Called by a linked ITargetBlock<TInput> to accept and consume a DataflowMessageHeader previously offered by this ISourceBlock<TOutput>. |
| ISourceBlock<TOutput>.ReleaseReservation(DataflowMessageHeader, ITargetBlock<TOutput>) |
Called by a linked ITargetBlock<TInput> to release a previously reserved DataflowMessageHeader by this ISourceBlock<TOutput>. |
| ISourceBlock<TOutput>.ReserveMessage(DataflowMessageHeader, ITargetBlock<TOutput>) |
Called by a linked ITargetBlock<TInput> to reserve a previously offered DataflowMessageHeader by this ISourceBlock<TOutput>. |
| ITargetBlock<TInput>.OfferMessage(DataflowMessageHeader, TInput, ISourceBlock<TInput>, Boolean) |
Offers a message to the ITargetBlock<TInput>, giving the target the opportunity to consume or postpone the message. |