Export (0) Print
Expand All

ExecutionDataflowBlockOptions Class

.NET Framework 4.5

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

System.Object
  System.Threading.Tasks.Dataflow.DataflowBlockOptions
    System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions

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

type ExecutionDataflowBlockOptions =  
    class 
        inherit DataflowBlockOptions 
    end

The ExecutionDataflowBlockOptions type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryExecutionDataflowBlockOptionsInitializes a new ExecutionDataflowBlockOptions.
Top

  NameDescription
Public propertySupported by Portable Class LibraryBoundedCapacityGets or sets the maximum number of messages that may be buffered by the block. (Inherited from DataflowBlockOptions.)
Public propertySupported by Portable Class LibraryCancellationTokenGets or sets the CancellationToken to monitor for cancellation requests. (Inherited from DataflowBlockOptions.)
Public propertySupported by Portable Class LibraryMaxDegreeOfParallelismGets the maximum number of messages that may be processed by the block concurrently.
Public propertySupported by Portable Class LibraryMaxMessagesPerTaskGets or sets the maximum number of messages that may be processed per task. (Inherited from DataflowBlockOptions.)
Public propertySupported by Portable Class LibraryNameFormatGets or sets the format string to use when a block is queried for its name. (Inherited from DataflowBlockOptions.)
Public propertySupported by Portable Class LibrarySingleProducerConstrainedGets whether code using the dataflow block is constrained to one producer at a time.
Public propertySupported by Portable Class LibraryTaskSchedulerGets or sets the TaskScheduler to use for scheduling tasks. (Inherited from DataflowBlockOptions.)
Top

  NameDescription
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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.

Portable Class Library

Supported in: Portable Class Library

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