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
doc: explicitly mention that Deadline might saturate #6085
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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 |
---|---|---|
|
@@ -55,6 +55,9 @@ public static Ticker getSystemTicker() { | |
* Create a deadline that will expire at the specified offset based on the {@link #getSystemTicker | ||
* system ticker}. | ||
* | ||
* <p>If the given offset is extraordinarily long, say 100 years, the actual deadline created | ||
* might saturate. | ||
* | ||
* @param duration A non-negative duration. | ||
* @param units The time unit for the duration. | ||
* @return A new deadline. | ||
|
@@ -66,6 +69,9 @@ public static Deadline after(long duration, TimeUnit units) { | |
/** | ||
* Create a deadline that will expire at the specified offset based on the given {@link Ticker}. | ||
* | ||
* <p>If the given offset is extraordinarily long, say 100 years, the actual deadline created | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/offset/duration/ here as well. The last instance is good as "offset" |
||
* might saturate. | ||
* | ||
* <p><strong>CAUTION</strong>: Only deadlines created with the same {@link Ticker} instance can | ||
* be compared by methods like {@link #minimum}, {@link #isBefore} and {@link #compareTo}. Custom | ||
* Tickers should only be used in tests where you fake out the clock. Always use the {@link | ||
|
@@ -141,6 +147,9 @@ public Deadline minimum(Deadline other) { | |
|
||
/** | ||
* Create a new deadline that is offset from {@code this}. | ||
* | ||
* <p>If the given offset is extraordinarily long, say 100 years, the actual deadline created | ||
* might saturate. | ||
*/ | ||
// TODO(ejona): This method can cause deadlines to grow too far apart. For example: | ||
// Deadline.after(100 * 365, DAYS).offset(100 * 365, DAYS) would be less than | ||
|
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.
s/offset/duration/
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.
Actually the first sentence mentioned offset
* Create a deadline that will expire at the specified offset
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.
Okay. This is fine then.