Export (0) Print
Expand All

DataflowLinkOptions Class

.NET Framework 4.5

Provides options used to configure a link between dataflow blocks.

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

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

public class DataflowLinkOptions

The DataflowLinkOptions type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryDataflowLinkOptionsInitializes the DataflowLinkOptions.
Top

  NameDescription
Public propertySupported by Portable Class LibraryAppendGets or sets whether the link should be appended to the source’s list of links, or whether it should be prepended.
Public propertySupported by Portable Class LibraryMaxMessagesGets or sets the maximum number of messages that may be consumed across the link.
Public propertySupported by Portable Class LibraryPropagateCompletionGets or sets whether the linked target will have completion and faulting notification propagated to it automatically.
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.

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.

.NET Framework

Supported in: 4.5

Portable Class Library

Supported in: Portable Class Library

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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