From c5f1ad402effa6fbd872316fed5940e9b356d407 Mon Sep 17 00:00:00 2001 From: Petr Onderka Date: Sun, 28 Apr 2019 11:45:59 +0200 Subject: [PATCH 1/2] Added documentation for DataflowBlockOptions.EnsureOrdered --- .../DataflowBlockOptions.xml | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml b/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml index 35afe47dcd9..7bf44c75676 100644 --- a/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml +++ b/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml @@ -143,9 +143,23 @@ System.Boolean - To be added. - To be added. - To be added. + Gets or sets whether ordered processing should be enforced on a block's handling of messages. + + will ensure that messages are output in the same +order they were input, even if parallelism is employed by the block and the processing of a message N finishes +after the processing of a subsequent message N+1 (the block will reorder the results to maintain the input +ordering prior to making those results available to a consumer). Some blocks may allow this to be relaxed, +however. Setting to false tells a block that it may relax this ordering if +it's able to do so. This can be beneficial if the immediacy of a processed result being made available +is more important than the input-to-output ordering being maintained. + +]]> + @@ -260,4 +274,4 @@ - \ No newline at end of file + From 8fe07601af57ecbb4041ba1c844b759c5391b7be Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 30 Apr 2019 00:02:12 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Co-Authored-By: svick --- .../DataflowBlockOptions.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml b/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml index 7bf44c75676..d615e9d2eb3 100644 --- a/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml +++ b/xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml @@ -150,13 +150,13 @@ ## Remarks By default, dataflow blocks enforce ordering on the processing of messages. This means that a -block like will ensure that messages are output in the same -order they were input, even if parallelism is employed by the block and the processing of a message N finishes +block like will ensure that messages are output in the same +order they were input, even if parallelism is employed by the block, and the processing of a message N finishes after the processing of a subsequent message N+1 (the block will reorder the results to maintain the input ordering prior to making those results available to a consumer). Some blocks may allow this to be relaxed, however. Setting to false tells a block that it may relax this ordering if -it's able to do so. This can be beneficial if the immediacy of a processed result being made available -is more important than the input-to-output ordering being maintained. +it's able to do so. This can be beneficial if making a processed result immediately available +is more important than maintaining the input-to-output ordering. ]]>