DataflowLinkOptions Class

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Source:

DataflowLinkOptions.cs

Provides options used to configure a link between dataflow blocks.

public ref class DataflowLinkOptions

public class DataflowLinkOptions

type DataflowLinkOptions = class

Public Class DataflowLinkOptions

Inheritance

Object

DataflowLinkOptions

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.

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.

Constructors

DataflowLinkOptions()

Initializes the DataflowLinkOptions.

Properties

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.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (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)