DataflowBlockOptions Class

 

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

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


public ref class DataflowBlockOptions 

NameDescription
System_CAPS_pubmethodDataflowBlockOptions()

Initializes a new DataflowBlockOptions.

NameDescription
System_CAPS_pubpropertyBoundedCapacity

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

System_CAPS_pubpropertyCancellationToken

Gets or sets the CancellationToken to monitor for cancellation requests.

System_CAPS_pubpropertyMaxMessagesPerTask

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

System_CAPS_pubpropertyNameFormat

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

System_CAPS_pubpropertyTaskScheduler

Gets or sets the TaskScheduler to use for scheduling tasks.

NameDescription
System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticUnbounded

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

System_CAPS_noteNote

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.

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

Return to top
Show: