ExecutionDataflowBlockOptions ExecutionDataflowBlockOptions ExecutionDataflowBlockOptions 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 ref class ExecutionDataflowBlockOptions : System::Threading::Tasks::Dataflow::DataflowBlockOptions
public class ExecutionDataflowBlockOptions : System.Threading.Tasks.Dataflow.DataflowBlockOptions
type ExecutionDataflowBlockOptions = class
    inherit DataflowBlockOptions
Public Class ExecutionDataflowBlockOptions
Inherits DataflowBlockOptions
Inheritance
ExecutionDataflowBlockOptionsExecutionDataflowBlockOptionsExecutionDataflowBlockOptionsExecutionDataflowBlockOptions

Remarks

Note

The TPL Dataflow Library (the System.Threading.Tasks.Dataflow namespace) is not distributed with .NET. To install the System.Threading.Tasks.Dataflow namespace in Visual Studio, open your project, choose Manage NuGet Packages from the Project menu, and search online for the System.Threading.Tasks.Dataflow package. Alternatively, to install it using the .NET Core CLI, run dotnet add package System.Threading.Tasks.Dataflow.

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() ExecutionDataflowBlockOptions() ExecutionDataflowBlockOptions() ExecutionDataflowBlockOptions()

Initializes a new ExecutionDataflowBlockOptions.

Properties

BoundedCapacity BoundedCapacity BoundedCapacity BoundedCapacity

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

(Inherited from DataflowBlockOptions)
CancellationToken CancellationToken CancellationToken CancellationToken

Gets or sets the CancellationToken to monitor for cancellation requests.

(Inherited from DataflowBlockOptions)
EnsureOrdered EnsureOrdered EnsureOrdered EnsureOrdered Inherited from DataflowBlockOptions
MaxDegreeOfParallelism MaxDegreeOfParallelism MaxDegreeOfParallelism MaxDegreeOfParallelism

Gets the maximum number of messages that may be processed by the block concurrently.

MaxMessagesPerTask MaxMessagesPerTask MaxMessagesPerTask MaxMessagesPerTask

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

(Inherited from DataflowBlockOptions)
NameFormat NameFormat NameFormat NameFormat

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

(Inherited from DataflowBlockOptions)
SingleProducerConstrained SingleProducerConstrained SingleProducerConstrained SingleProducerConstrained

Gets whether code using the dataflow block is constrained to one producer at a time.

TaskScheduler TaskScheduler TaskScheduler TaskScheduler

Gets or sets the TaskScheduler to use for scheduling tasks.

(Inherited from DataflowBlockOptions)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Fields

Unbounded Unbounded Unbounded Unbounded

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

(Inherited from DataflowBlockOptions)

Applies to