ExecutionDataflowBlockOptions.SingleProducerConstrained Property

Definition

Namespace:

System.Threading.Tasks.Dataflow

Assembly:

System.Threading.Tasks.Dataflow.dll

Source:

DataflowBlockOptions.cs

Gets whether code using the dataflow block is constrained to one producer at a time.

public:
 property bool SingleProducerConstrained { bool get(); void set(bool value); };

public bool SingleProducerConstrained { get; set; }

member this.SingleProducerConstrained : bool with get, set

Public Property SingleProducerConstrained As Boolean

Property Value

Boolean

Returns Boolean.

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.