Skip to content

Commit

Permalink
Merge pull request #3212 from anagainaru/ondemand-doc
Browse files Browse the repository at this point in the history
Update documentation with correct StepDistributionMode values
  • Loading branch information
anagainaru authored May 12, 2022
2 parents 00a7dca + 66a76f3 commit 70d5bfe
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/user_guide/source/engines/sst.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,15 +267,15 @@ eager data sending of all data from each writer to all readers.
Currently value is interpreted by only by the SST Reader engine.


17. ``StepDistributionMode``: Default **"StepsAllToAll"**. This value
17. ``StepDistributionMode``: Default **"AllToAll"**. This value
controls how steps are distributed, particularly when there are
multiple readers. By default, the value is **StepsAllToAll*, which
multiple readers. By default, the value is **"AllToAll"**, which
means that all timesteps are to be delivered to all readers (subject
to discard rules, etc.). In other distribution modes, this is not the
case. For example, in **"StepsRoundRobin"**, each step is delivered
case. For example, in **"RoundRobin"**, each step is delivered
only to a single reader, determined in a round-robin fashion based
upon the number or readers who have opened the stream at the time the
step is submitted. In **"StepsOnDemand"** each step is delivered to a
step is submitted. In **"OnDemand"** each step is delivered to a
single reader, but only upon request (with a request being initiated
by the reader doing BeginStep()). Normal reader-side rules (like
BeginStep timeouts) and writer-side rules (like queue limit behavior) apply.
Expand Down

0 comments on commit 70d5bfe

Please sign in to comment.