Skip to content

Added documentation for DataflowBlockOptions.EnsureOrdered #2374

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 29, 2019
Merged

Added documentation for DataflowBlockOptions.EnsureOrdered #2374

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5f1ad4
Added documentation for DataflowBlockOptions.EnsureOrdered
svick Apr 28, 2019
8fe0760
Apply suggestions from code review
Apr 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions xml/System.Threading.Tasks.Dataflow/DataflowBlockOptions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,23 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets or sets whether ordered processing should be enforced on a block's handling of messages.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

By default, dataflow blocks enforce ordering on the processing of messages. This means that a
block like <xref:System.Threading.Tasks.Dataflow.TransformBlock%602?displayProperty=nameWithType> 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 <xref:System.Threading.Tasks.Dataflow.DataflowBlockOptions.EnsureOrdered> to false tells a block that it may relax this ordering if
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.

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxMessagesPerTask">
Expand Down Expand Up @@ -260,4 +274,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>