GroupingDataflowBlockOptions Class

 

Provides options used to configure the processing performed by dataflow blocks that group together multiple messages. These are dataflow blocks such as JoinBlock<T1, T2> and BatchBlock<T>.

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

System::Object
System.Threading.Tasks.Dataflow::DataflowBlockOptions
System.Threading.Tasks.Dataflow::GroupingDataflowBlockOptions

public ref class GroupingDataflowBlockOptions : DataflowBlockOptions

NameDescription
System_CAPS_pubmethodGroupingDataflowBlockOptions()

Initializes a new GroupingDataflowBlockOptions.

NameDescription
System_CAPS_pubpropertyBoundedCapacity

Gets or sets the maximum number of messages that may be buffered by the block.(Inherited from DataflowBlockOptions.)

System_CAPS_pubpropertyCancellationToken

Gets or sets the CancellationToken to monitor for cancellation requests. (Inherited from DataflowBlockOptions.)

System_CAPS_pubpropertyGreedy

Gets or sets the Boolean value to use to determine whether to greedily consume offered messages.

System_CAPS_pubpropertyMaxMessagesPerTask

Gets or sets the maximum number of messages that may be processed per task.(Inherited from DataflowBlockOptions.)

System_CAPS_pubpropertyMaxNumberOfGroups

Gets or sets the maximum number of groups that should be generated by the block.

System_CAPS_pubpropertyNameFormat

Gets or sets the format string to use when a block is queried for its name.(Inherited from DataflowBlockOptions.)

System_CAPS_pubpropertyTaskScheduler

Gets or sets the TaskScheduler to use for scheduling tasks.(Inherited from DataflowBlockOptions.)

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.)

System_CAPS_noteNote

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.

GroupingDataflowBlockOptions 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)

MaxNumberOfGroups

GroupingDataflowBlockOptions.Unbounded (-1)

Greedy

true

Dataflow block capture the state of the options at their construction. Subsequent changes to the provided GroupingDataflowBlockOptions 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: