flasn4nt
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: explicitly mention that Deadline might saturate

This commit is contained in:
ZHANG Dapeng 2019-08-20 14:28:45 -07:00 committed by GitHub
parent 3a9616fc25
commit 92805713e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
context/src/main/java/io/grpc/Deadline.java
View File

@ -55,6 +55,9 @@ public final class Deadline implements Comparable<Deadline> {
* Create a deadline that will expire at the specified offset based on the {@link #getSystemTicker * Create a deadline that will expire at the specified offset based on the {@link #getSystemTicker
* system ticker}. * 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 duration A non-negative duration.
* @param units The time unit for the duration. * @param units The time unit for the duration.
* @return A new deadline. * @return A new deadline.
@ -66,6 +69,9 @@ public final class Deadline implements Comparable<Deadline> {
/** /**
* Create a deadline that will expire at the specified offset based on the given {@link Ticker}. * 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
* might saturate.
*
* <p><strong>CAUTION</strong>: Only deadlines created with the same {@link Ticker} instance can * <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 * 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 * Tickers should only be used in tests where you fake out the clock. Always use the {@link
@ -141,6 +147,9 @@ public final class Deadline implements Comparable<Deadline> {
/** /**
* Create a new deadline that is offset from {@code this}. * 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: // 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 // Deadline.after(100 * 365, DAYS).offset(100 * 365, DAYS) would be less than