Class SynchronizationContext.ScheduledHandle

java.lang.Object

io.grpc.SynchronizationContext.ScheduledHandle

Enclosing class:

SynchronizationContext

public static final class SynchronizationContext.ScheduledHandle
extends Object

Allows the user to check the status and/or cancel a task scheduled by SynchronizationContext.schedule(Runnable, long, TimeUnit, ScheduledExecutorService).

This class is NOT thread-safe. All methods must be run from the same SynchronizationContext as which the task was scheduled in.

Since:

1.17.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ScheduledFuture<?>	future
private final SynchronizationContext.ManagedRunnable	runnable

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ScheduledHandle(SynchronizationContext.ManagedRunnable runnable, ScheduledFuture<?> future)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancel the task if it's still pending.
boolean	isPending()	Returns true if the task will eventually run, meaning that it has neither started running nor been cancelled.

Methods inherited from class Object

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

Field Details

runnable

private final SynchronizationContext.ManagedRunnable runnable

future

private final ScheduledFuture<?> future

Constructor Details

ScheduledHandle

private ScheduledHandle(SynchronizationContext.ManagedRunnable runnable,
 ScheduledFuture<?> future)

Method Details

cancel

public void cancel()

Cancel the task if it's still pending.

isPending

public boolean isPending()

Returns true if the task will eventually run, meaning that it has neither started running nor been cancelled.