Skip to content

3.x: JavaDocs: clarify create emitters are per consumer #6535

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.

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 1 commit into from
Jun 24, 2019

Conversation

akarnokd
Copy link
Member

This PR adds this documentation part to the various create JavaDocs (adapted):

Whenever an Observer subscribes to the returned Observable, the provided
ObservableOnSubscribe callback is invoked with a fresh instance of an ObservableEmitter
that will interact only with that specific Observer. If this Observer
disposes the flow (making ObservableEmitter#isDisposed return true),
other observers subscribed to the same returned Observable are not affected.

Resolves #6390

@akarnokd akarnokd added this to the 3.0 milestone Jun 21, 2019
@codecov
Copy link

codecov bot commented Jun 21, 2019

Codecov Report

Merging #6535 into 3.x will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##                3.x   #6535      +/-   ##
===========================================
- Coverage     98.21%   98.2%   -0.01%     
+ Complexity     6189    6188       -1     
===========================================
  Files           680     680              
  Lines         44883   44883              
  Branches       6193    6193              
===========================================
- Hits          44081   44078       -3     
- Misses          261     263       +2     
- Partials        541     542       +1
Impacted Files Coverage Δ Complexity Δ
src/main/java/io/reactivex/Flowable.java 100% <ø> (ø) 566 <0> (ø) ⬇️
src/main/java/io/reactivex/Completable.java 100% <ø> (ø) 118 <0> (ø) ⬇️
src/main/java/io/reactivex/Observable.java 100% <ø> (ø) 541 <0> (ø) ⬇️
src/main/java/io/reactivex/Maybe.java 100% <ø> (ø) 172 <0> (ø) ⬇️
src/main/java/io/reactivex/Single.java 100% <ø> (ø) 148 <0> (ø) ⬇️
...nternal/operators/observable/ObservableCreate.java 95.72% <0%> (-3.42%) 2% <0%> (ø)
...ernal/operators/flowable/FlowableFlatMapMaybe.java 88.88% <0%> (-2.9%) 2% <0%> (ø)
...ternal/operators/completable/CompletableMerge.java 96.42% <0%> (-2.39%) 2% <0%> (ø)
...ex/internal/subscriptions/SubscriptionArbiter.java 98.31% <0%> (-1.69%) 50% <0%> (-1%)
...io/reactivex/subscribers/SerializedSubscriber.java 98.86% <0%> (-1.14%) 26% <0%> (-1%)
... and 16 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 46b4ac8...599ebaa. Read the comment docs.

@akarnokd akarnokd merged commit 1fe60f5 into ReactiveX:3.x Jun 24, 2019
@akarnokd akarnokd deleted the EmitterClarifications branch June 24, 2019 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant