io.grpc

Class Deadline

java.lang.Object

io.grpc.Deadline

All Implemented Interfaces:

Comparable<Deadline>

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/262")
public final class Deadline
extends Object
implements Comparable<Deadline>

An absolute deadline in system time.

Method Summary

Modifier and Type	Method and Description
static Deadline	after(long duration, TimeUnit units) Create a deadline that will expire at the specified offset from the current system clock.
int	compareTo(Deadline that)
boolean	isBefore(Deadline other) Is this deadline before another.
boolean	isExpired() Has this deadline expired
Deadline	minimum(Deadline other) Return the minimum deadline of this or an other deadline.
Deadline	offset(long offset, TimeUnit units) Create a new deadline that is offset from this.
ScheduledFuture<?>	runOnExpiration(Runnable task, ScheduledExecutorService scheduler) Schedule a task to be run when the deadline expires.
long	timeRemaining(TimeUnit unit) How much time is remaining in the specified time unit.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

after

public static Deadline after(long duration,
                             TimeUnit units)

Create a deadline that will expire at the specified offset from the current system clock.

Parameters:

duration - A non-negative duration.

units - The time unit for the duration.

Returns:

A new deadline.

isExpired

public boolean isExpired()

Has this deadline expired

Returns:

true if it has, otherwise false.

isBefore

public boolean isBefore(Deadline other)

Is this deadline before another.

minimum

public Deadline minimum(Deadline other)

Return the minimum deadline of this or an other deadline.

Parameters:

other - deadline to compare with this.

offset

public Deadline offset(long offset,
                       TimeUnit units)

Create a new deadline that is offset from this.

timeRemaining

public long timeRemaining(TimeUnit unit)

How much time is remaining in the specified time unit. Internal units are maintained as nanoseconds and conversions are subject to the constraints documented for TimeUnit.convert(long, java.util.concurrent.TimeUnit). If there is no time remaining, the returned duration is how long ago the deadline expired.

runOnExpiration

public ScheduledFuture<?> runOnExpiration(Runnable task,
                                          ScheduledExecutorService scheduler)

Schedule a task to be run when the deadline expires.

Parameters:

task - to run on expiration

scheduler - used to execute the task

Returns:

ScheduledFuture which can be used to cancel execution of the task

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Deadline that)

Specified by:

compareTo in interface Comparable<Deadline>