@Incubating public interface CancellationTokenSource
CancellationTokenSource allows you to issue cancellation requests to one or more LongRunningOperation
instances. To use a token source:
GradleConnector.newCancellationTokenSource().LongRunningOperation.withCancellationToken(CancellationToken).
You need to do this before you start the operation.
cancel() on this token source.All implementations of this interface are required to be thread safe.
| Modifier and Type | Method and Description |
|---|---|
void |
cancel()
Initiates cancel request.
|
CancellationToken |
token()
Returns a token associated with this
CancellationTokenSource. |
void cancel()
It is assumed that the implementation will do 'best-effort' attempt to perform cancellation.
This method returns immediately and if the cancellation is successful the cancelled operation
will notify its ResultHandler.onFailure(GradleConnectionException)
with a BuildCancelledException describing how it was cancelled.
CancellationToken token()
CancellationTokenSource.
Always returns the same instance.