DataflowLinkOptions Class
Provides options used to configure a link between dataflow blocks.
Namespace: System.Threading.Tasks.Dataflow
Assembly: System.Threading.Tasks.Dataflow (in System.Threading.Tasks.Dataflow.dll)
The DataflowLinkOptions type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | Append | Gets or sets whether the link should be appended to the source’s list of links, or whether it should be prepended. |
![]() ![]() | MaxMessages | Gets or sets the maximum number of messages that may be consumed across the link. |
![]() ![]() | PropagateCompletion | Gets or sets whether the linked target will have completion and faulting notification propagated to it automatically. |
| Name | Description | |
|---|---|---|
![]() ![]() | Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
Note |
|---|
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. |
DataflowLinkOptions is mutable and can be configured through its properties.
When specific configuration options are not set, the following defaults are used:
Options | Default |
|---|---|
PropagateCompletion | False |
MaxMessages | DataflowBlockOptions.Unbounded (-1) |
Append | True |
Dataflow blocks capture the state of the options at linking. Subsequent changes to the provided DataflowLinkOptions instance should not affect the behavior of a link.




Note