Skip to content
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

Jump to bottom

Document possible alternative to replay ManySink limit(0) #2787

Merged
merged 1 commit into from
Sep 24, 2021
Merged

Document possible alternative to replay ManySink limit(0) #2787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions reactor-core/src/main/java/reactor/core/publisher/Sinks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,9 @@ public interface MulticastReplaySpec {
* <li>Replaying: up to {@code historySize} elements pushed to this sink are replayed to new subscribers.
* Older elements are discarded.</li>
* </ul>
* <p>
* Note that though historySize of zero is forbidden, the desired equivalent effect can usually be achieved
* with the {@link Duration} based variant: {@link #limit(Duration) limit(Duration.ZERO)}.
*
* @param historySize maximum number of elements able to replayed, strictly positive
*/
Expand Down Expand Up @@ -611,6 +614,9 @@ public interface MulticastReplaySpec {
* Older elements are discarded.</li>
* </ul>
* Note: Age is checked when a signal occurs, not using a background task.
* <p>
* Note that though historySize of zero is forbidden, the desired equivalent effect can usually be achieved
* by setting the {@code maxAge} to {@link Duration#ZERO}.
*
* @param historySize maximum number of elements able to replayed, strictly positive
* @param maxAge maximum retention time for elements to be retained
Expand All @@ -628,6 +634,9 @@ public interface MulticastReplaySpec {
* Older elements are discarded.</li>
* </ul>
* Note: Age is checked when a signal occurs, not using a background task.
* <p>
* Note that though historySize of zero is forbidden, the desired equivalent effect can usually be achieved
* by setting the {@code maxAge} to {@link Duration#ZERO}.
*
* @param historySize maximum number of elements able to replayed, strictly positive
* @param maxAge maximum retention time for elements to be retained
Expand Down