Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
136 lines (126 sloc) 8.12 KB
<Type Name="ExecutionDataflowBlockOptions" FullName="System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions">
<TypeSignature Language="C#" Value="public class ExecutionDataflowBlockOptions : System.Threading.Tasks.Dataflow.DataflowBlockOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ExecutionDataflowBlockOptions extends System.Threading.Tasks.Dataflow.DataflowBlockOptions" />
<TypeSignature Language="DocId" Value="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ExecutionDataflowBlockOptions&#xA;Inherits DataflowBlockOptions" />
<TypeSignature Language="C++ CLI" Value="public ref class ExecutionDataflowBlockOptions : System::Threading::Tasks::Dataflow::DataflowBlockOptions" />
<TypeSignature Language="F#" Value="type ExecutionDataflowBlockOptions = class&#xA; inherit DataflowBlockOptions" />
<AssemblyInfo>
<AssemblyName>System.Threading.Tasks.Dataflow</AssemblyName>
<AssemblyVersion>4.5.25.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.6.1.0</AssemblyVersion>
<AssemblyVersion>4.6.2.0</AssemblyVersion>
<AssemblyVersion>4.6.3.0</AssemblyVersion>
<AssemblyVersion>4.6.4.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Threading.Tasks.Dataflow.DataflowBlockOptions</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netcore-1.0;netcore-1.1;dotnet-uwp-10.0">
<AttributeName>System.Diagnostics.DebuggerDisplay("TaskScheduler = {TaskScheduler}, MaxMessagesPerTask = {MaxMessagesPerTask}, BoundedCapacity = {BoundedCapacity}, MaxDegreeOfParallelism = {MaxDegreeOfParallelism}")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>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 <see cref="T:System.Threading.Tasks.Dataflow.ActionBlock`1" /> and <see cref="T:System.Threading.Tasks.Dataflow.TransformBlock`2" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
[!INCLUDE [tpl-install-instructions](~/includes/tpl-install-instructions.md)]
<xref:System.Threading.Tasks.Dataflow.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|<xref:System.Threading.Tasks.TaskScheduler.Default%2A>|
|CancellationToken|<xref:System.Threading.CancellationToken.None%2A>|
|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 <xref:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions> instance should not affect the behavior of a dataflow block.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ExecutionDataflowBlockOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; ExecutionDataflowBlockOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Tasks.Dataflow</AssemblyName>
<AssemblyVersion>4.5.25.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.6.1.0</AssemblyVersion>
<AssemblyVersion>4.6.2.0</AssemblyVersion>
<AssemblyVersion>4.6.3.0</AssemblyVersion>
<AssemblyVersion>4.6.4.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new <see cref="T:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxDegreeOfParallelism">
<MemberSignature Language="C#" Value="public int MaxDegreeOfParallelism { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxDegreeOfParallelism" />
<MemberSignature Language="DocId" Value="P:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.MaxDegreeOfParallelism" />
<MemberSignature Language="VB.NET" Value="Public Property MaxDegreeOfParallelism As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property int MaxDegreeOfParallelism { int get(); void set(int value); };" />
<MemberSignature Language="F#" Value="member this.MaxDegreeOfParallelism : int with get, set" Usage="System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.MaxDegreeOfParallelism" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Tasks.Dataflow</AssemblyName>
<AssemblyVersion>4.5.25.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.6.1.0</AssemblyVersion>
<AssemblyVersion>4.6.2.0</AssemblyVersion>
<AssemblyVersion>4.6.3.0</AssemblyVersion>
<AssemblyVersion>4.6.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the maximum number of messages that may be processed by the block concurrently.</summary>
<value>The maximum number of messages.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SingleProducerConstrained">
<MemberSignature Language="C#" Value="public bool SingleProducerConstrained { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SingleProducerConstrained" />
<MemberSignature Language="DocId" Value="P:System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.SingleProducerConstrained" />
<MemberSignature Language="VB.NET" Value="Public Property SingleProducerConstrained As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool SingleProducerConstrained { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.SingleProducerConstrained : bool with get, set" Usage="System.Threading.Tasks.Dataflow.ExecutionDataflowBlockOptions.SingleProducerConstrained" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Threading.Tasks.Dataflow</AssemblyName>
<AssemblyVersion>4.5.25.0</AssemblyVersion>
<AssemblyVersion>4.6.0.0</AssemblyVersion>
<AssemblyVersion>4.6.1.0</AssemblyVersion>
<AssemblyVersion>4.6.2.0</AssemblyVersion>
<AssemblyVersion>4.6.3.0</AssemblyVersion>
<AssemblyVersion>4.6.4.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets whether code using the dataflow block is constrained to one producer at a time.</summary>
<value>Returns <see cref="T:System.Boolean" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property defaults to false, such that the block may be used by multiple producers concurrently. This property should only be set to true if the code using the block can guarantee that it will only ever be used by one producer (e.g. a source linked to the block) at a time, meaning that methods like Post, Complete, Fault, and OfferMessage will never be called concurrently. Some blocks may choose to capitalize on the knowledge that there will only be one producer at a time in order to provide better performance.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.