api / org.gradle.tooling / CancellationTokenSource / cancel

cancel

abstract fun cancel(): Unit

Initiates cancel request. All operations that have been associated with this token will be cancelled.

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 org.gradle.tooling.ResultHandler#onFailure(GradleConnectionException) with a BuildCancelledException describing how it was cancelled.