DataflowBlockOptions Class

Definition

Provides options used to configure the processing performed by dataflow blocks.

public class DataflowBlockOptions
Inheritance
DataflowBlockOptions
Derived

Inherited Members

System.Object

Remarks

Note

The TPL Dataflow Library (System.Threading.Tasks.Dataflow namespace) is not distributed with the net_v45. 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.

DataflowBlockOptions 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
MaxMessagesPerTask DataflowBlockOptions.Unbounded (-1)
CancellationToken None
BoundedCapacity DataflowBlockOptions.Unbounded (-1)

Dataflow blocks capture the state of the options at their construction. Subsequent changes to the provided DataflowBlockOptions instance should not affect the behavior of a dataflow block.

Constructors

DataflowBlockOptions()

Initializes a new DataflowBlockOptions.

Fields

Unbounded

A constant used to specify an unlimited quantity for DataflowBlockOptions members that provide an upper bound. This field is constant.

Properties

BoundedCapacity

Gets or sets the maximum number of messages that may be buffered by the block.

CancellationToken

Gets or sets the CancellationToken to monitor for cancellation requests.

EnsureOrdered
MaxMessagesPerTask

Gets or sets the maximum number of messages that may be processed per task.

NameFormat

Gets or sets the format string to use when a block is queried for its name.

TaskScheduler

Gets or sets the TaskScheduler to use for scheduling tasks.