Skip to content

Commit

Permalink
[doc] Improve Mono#share javadoc for cancelling
Browse files Browse the repository at this point in the history
Similarly to Flux#share, Mono#share also cancels the source when all
Subscribers have cancelled. This change improves the documentation.

Following #2680 and #2756 there exists a misalignment in the javadoc for
Mono#share method. Since cancelling the source is a fact, the
javadoc is now improved instead of changing the behaviour.

Resolves #3740
  • Loading branch information
chemicL committed Mar 6, 2024
1 parent b0d23de commit f4af9da
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions reactor-core/src/main/java/reactor/core/publisher/Mono.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2016-2022 VMware Inc. or its affiliates, All Rights Reserved.
* Copyright (c) 2016-2024 VMware Inc. or its affiliates, All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -4236,9 +4236,10 @@ public final Mono<T> retryWhen(Retry retrySpec) {
/**
* Prepare a {@link Mono} which shares this {@link Mono} result similar to {@link Flux#shareNext()}.
* This will effectively turn this {@link Mono} into a hot task when the first
* {@link Subscriber} subscribes using {@link #subscribe()} API. Further {@link Subscriber} will share the same {@link Subscription}
* {@link Subscriber} subscribes using {@link #subscribe()} API.
* Further {@link Subscriber} will share the same {@link Subscription}
* and therefore the same result.
* It's worth noting this is an un-cancellable {@link Subscription}.
* When all subscribers have cancelled it will cancel the source {@link Mono}.
* <p>
* <img class="marble" src="doc-files/marbles/shareForMono.svg" alt="">
*
Expand Down

0 comments on commit f4af9da

Please sign in to comment.