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)

System::Object
System.Threading.Tasks.Dataflow::DataflowLinkOptions

public ref class DataflowLinkOptions 

NameDescription
System_CAPS_pubmethodDataflowLinkOptions()

Initializes the DataflowLinkOptions.

NameDescription
System_CAPS_pubpropertyAppend

Gets or sets whether the link should be appended to the source’s list of links, or whether it should be prepended.

System_CAPS_pubpropertyMaxMessages

Gets or sets the maximum number of messages that may be consumed across the link.

System_CAPS_pubpropertyPropagateCompletion

Gets or sets whether the linked target will have completion and faulting notification propagated to it automatically.

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.

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.

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: