Skip to content

Commit

Permalink
Update docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
Browse files Browse the repository at this point in the history
Co-authored-by: Arnout Engelen <arnout@engelen.eu>
  • Loading branch information
Roiocam and raboof authored May 28, 2024
1 parent ffe3858 commit f69de95
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Java
: @@snip [Throttle.java](/docs/src/test/java/jdocs/stream/operators/sourceorflow/Throttle.java) { #throttle-with-burst }

The extra argument to set the `ThrottleMode` to `shaping` tells throttle to make pauses to avoid exceeding
the maximum rate. Alternatively we could set the `ThrottleMode` to `enforcing` cause a stream failure when upstream is faster
the maximum rate. Alternatively we could set the `ThrottleMode` to `enforcing` to cause a stream failure when upstream is faster
than the throttle rate.

The examples above don't cover all the parameters supported by `throttle` (e.g. `cost`-based throttling). See the
Expand Down

0 comments on commit f69de95

Please sign in to comment.