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

doc: explicitly mention that Deadline might saturate #6085

Merged
merged 1 commit into from Aug 20, 2019
Merged

doc: explicitly mention that Deadline might saturate #6085

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 context/src/main/java/io/grpc/Deadline.java
View file
Open in desktop
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/offset/duration/

Copy link
Member Author

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

Copy link
Member

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.

* might saturate.
*
* @param duration A non-negative duration.
* @param units The time unit for the duration.
* @return A new deadline.
Expand All @@ -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
Copy link
Member

Choose a reason for hiding this comment

The 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
Expand Down Expand Up @@ -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
Expand Down