io.grpc

Class Context.CancellableContext

java.lang.Object

io.grpc.Context

io.grpc.Context.CancellableContext

Enclosing class:

Context

public static final class Context.CancellableContext
extends Context

A context which inherits cancellation from its parent but which can also be independently cancelled and which will propagate cancellation to its descendants.

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.Context

Context.CancellableContext, Context.CancellationListener, Context.Key<T>

Field Summary

Fields inherited from class io.grpc.Context

ROOT

Method Summary

Modifier and Type	Method and Description
Context	attach() Attach this context to the thread and make it Context.current(), the previously current context is returned.
boolean	cancel(Throwable cause) Cancel this context and optionally provide a cause for the cancellation.
Throwable	cancellationCause() If a context Context.isCancelled() then return the cause of the cancellation or null if context was cancelled without a cause.
void	detach(Context toAttach) Detach the current context from the thread and attach the provided replacement.
void	detachAndCancel(Context toAttach, Throwable cause) Cancel this context and detach it as the current context from the thread.
boolean	isCancelled() Is this context cancelled.
boolean	isCurrent()

Methods inherited from class io.grpc.Context

addListener, call, current, currentContextExecutor, fixedContextExecutor, fork, getDeadline, key, keyWithDefault, removeListener, run, withCancellation, withDeadline, withDeadlineAfter, withValue, withValues, withValues, wrap, wrap

Methods inherited from class java.lang.Object

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

Method Detail

attach

public Context attach()

Description copied from class: Context

Attach this context to the thread and make it Context.current(), the previously current context is returned. It is allowed to attach contexts where Context.isCancelled() is true.

Instead of using Context.attach() & Context.detach(Context) most use-cases are better served by using the Context.run(Runnable) or Context.call(java.util.concurrent.Callable) to execute work immediately within a context. If work needs to be done in other threads it is recommended to use the 'wrap' methods or to use a propagating executor.

Overrides:

attach in class Context

detach

public void detach(Context toAttach)

Description copied from class: Context

Detach the current context from the thread and attach the provided replacement. If this context is not Context.current() a SEVERE message will be logged but the context to attach will still be bound.

Overrides:

detach in class Context

isCurrent

public boolean isCurrent()

cancel

public boolean cancel(@Nullable
                      Throwable cause)

Cancel this context and optionally provide a cause for the cancellation. This will trigger notification of listeners.

Returns:

true if this context cancelled the context and notified listeners, false if the context was already cancelled.

detachAndCancel

public void detachAndCancel(Context toAttach,
                            @Nullable
                            Throwable cause)

Cancel this context and detach it as the current context from the thread.

Parameters:

toAttach - context to make current.

cause - of cancellation, can be null.

isCancelled

public boolean isCancelled()

Description copied from class: Context

Is this context cancelled.

Overrides:

isCancelled in class Context

cancellationCause

@Nullable
public Throwable cancellationCause()

Description copied from class: Context

If a context Context.isCancelled() then return the cause of the cancellation or null if context was cancelled without a cause. If the context is not yet cancelled will always return null.

The cancellation cause is provided for informational purposes only and implementations should generally assume that it has already been handled and logged properly.

Overrides:

cancellationCause in class Context