ExecutionDataflowBlockOptions
Class
Definition
Provides options used to configure the processing performed by dataflow blocks that process each message through the invocation of a user-provided delegate. These are dataflow blocks such as ActionBlock<TInput> and TransformBlock<TInput,TOutput>.
public class ExecutionDataflowBlockOptions : System.Threading.Tasks.Dataflow.DataflowBlockOptions
- Inheritance
Inherited Members
System.Object
System.Threading.Tasks.Dataflow.DataflowBlockOptions
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.
ExecutionDataflowBlockOptions is mutable and can be configured through its properties.
When specific configuration options are not set, the following defaults are used:
| Options | Default |
|---|---|
| TaskScheduler | Default |
| CancellationToken | None |
| MaxMessagesPerTask | DataflowBlockOptions.Unbounded (-1) |
| BoundedCapacity | DataflowBlockOptions.Unbounded (-1) |
| MaxDegreeOfParallelism | 1 |
Dataflow block capture the state of the options at their construction. Subsequent changes to the provided ExecutionDataflowBlockOptions instance should not affect the behavior of a dataflow block.
Constructors
| ExecutionDataflowBlockOptions() |
Initializes a new ExecutionDataflowBlockOptions. |
Properties
| MaxDegreeOfParallelism |
Gets the maximum number of messages that may be processed by the block concurrently. |
| SingleProducerConstrained |
Gets whether code using the dataflow block is constrained to one producer at a time. |