-
Notifications
You must be signed in to change notification settings - Fork 110
Add UnicastSubject #213
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
Add UnicastSubject #213
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
57 changes: 57 additions & 0 deletions
57
src/main/scala/rx/lang/scala/subjects/UnicastSubject.scala
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /** | ||
| * Copyright 2013 Netflix, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package rx.lang.scala.subjects | ||
|
|
||
| import rx.annotations.Experimental | ||
| import rx.lang.scala.Subject | ||
|
|
||
| /** | ||
| * $experimental A `Subject` variant which buffers events until a single `Subscriber` arrives and replays | ||
| * them to it and potentially switches to direct delivery once the `Subscriber` caught up and requested an | ||
| * unlimited amount. In this case, the buffered values are no longer retained. If the `Subscriber` requests | ||
| * a limited amount, queueing is involved and only those values are retained which weren't requested by the | ||
| * `Subscriber` at that time. | ||
| * | ||
| * @define experimental | ||
| * <span class="badge badge-red" style="float: right;">EXPERIMENTAL</span> | ||
| */ | ||
| @Experimental | ||
| object UnicastSubject { | ||
|
|
||
| /** | ||
| * $experimental Constructs an empty `UnicastSubject` instance with the default capacity hint of 16 elements. | ||
| * | ||
| * @tparam T the input and output value type | ||
| * @return the created `UnicastSubject` instance | ||
| */ | ||
| @Experimental | ||
| def apply[T](): UnicastSubject[T] = new UnicastSubject[T](rx.subjects.UnicastSubject.create[T]()) | ||
|
|
||
| /** | ||
| * $experimental Constructs an empty UnicastSubject instance with a capacity hint. | ||
| * <p>The capacity hint determines the internal queue's island size: the larger | ||
| * it is the less frequent allocation will happen if there is no subscriber | ||
| * or the subscriber hasn't caught up. | ||
| * | ||
| * @param capacity the capacity hint for the internal queue | ||
| * @tparam T the input and output value type | ||
| * @return the created `UnicastSubject` instance | ||
| */ | ||
| @Experimental | ||
| def apply[T](capacity: Int): UnicastSubject[T] = new UnicastSubject[T](rx.subjects.UnicastSubject.create(capacity)) | ||
| } | ||
|
|
||
| private [scala] class UnicastSubject[T] private [scala] (val asJavaSubject: rx.subjects.UnicastSubject[T]) extends Subject[T] {} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Putting the
@Experimentalannotation here is fine, but in addition, you could also add a red badge in the scaladoc comment, as in ErrorDelayingObservable.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, it looks fine!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ruippeixotog you forgot to add
$experimentalto the class doc.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done. I also added
@Experimentalto the methods in order to be consistent with what was done inErrorDelayingObservable.