kafka.tier.fetcher

Class CancellationContext

java.lang.Object

kafka.tier.fetcher.CancellationContext

All Implemented Interfaces:

Closeable, AutoCloseable

public class CancellationContext
extends Object
implements Closeable

A tree to notify processes of cancellation in a thread safe way. Parent element in the tree can result in cancellation of children. Useful for request chaining where we wish to maintain a root handle for cancellation, or the ability to cancel sub-requests arbitrarily.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this CancellationContext, causing all sub-CancellationContexts to cancel.
void	close()
boolean	isCancelled() Get the cancellation status of this CancellationContext.
static CancellationContext	newContext() Create a new root CancellationContext.
CancellationContext	subContext() Create a new child CancellationContext.

Methods inherited from class java.lang.Object

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

Method Detail

newContext

public static CancellationContext newContext()

Create a new root CancellationContext. For use when starting a request chain. Generation of sub-contexts should be done through subContext()

Returns:

A new root CancellationContext with no parent.

subContext

public CancellationContext subContext()

Create a new child CancellationContext.

Returns:

a new child CancellationContext

cancel

public void cancel()

Cancel this CancellationContext, causing all sub-CancellationContexts to cancel.

isCancelled

public boolean isCancelled()

Get the cancellation status of this CancellationContext.

Returns:

if this CancellationContext (or any parent) is canceled.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable