Stay organized with collections
Save and categorize content based on your preferences.
public class CancellationTokenSource
Creates a new CancellationToken
or cancels one that has already created. There is a 1:1 CancellationTokenSource
to CancellationToken
relationship.
To create a CancellationToken
, create a CancellationTokenSource
first and then call getToken
to get the CancellationToken
for this CancellationTokenSource
.
Summary
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eCancellationTokenSource\u003c/code\u003e manages and controls the cancellation of associated \u003ccode\u003eCancellationToken\u003c/code\u003e instances.\u003c/p\u003e\n"],["\u003cp\u003eUse \u003ccode\u003eCancellationTokenSource\u003c/code\u003e to create and cancel \u003ccode\u003eCancellationToken\u003c/code\u003e objects, enabling task cancellation in asynchronous operations.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eCancellationToken\u003c/code\u003e can be obtained from a \u003ccode\u003eCancellationTokenSource\u003c/code\u003e using the \u003ccode\u003egetToken()\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eCalling \u003ccode\u003ecancel()\u003c/code\u003e on a \u003ccode\u003eCancellationTokenSource\u003c/code\u003e signals cancellation to its corresponding \u003ccode\u003eCancellationToken\u003c/code\u003e.\u003c/p\u003e\n"]]],["`CancellationTokenSource` manages the creation and cancellation of a `CancellationToken`. To use, a `CancellationTokenSource` instance is created, and then `getToken` is called to retrieve the corresponding `CancellationToken`. This `CancellationToken` can be passed to asynchronous tasks for cancellation. The `cancel` method allows for the cancellation of the associated `CancellationToken`, provided it hasn't already been cancelled. There is a one-to-one relationship between the Source and Token.\n"],null,["# CancellationTokenSource\n=======================\n\n[Kotlin](/android/reference/kotlin/com/google/android/gms/tasks/CancellationTokenSource \"View this page in Kotlin\") \\|Java \n\n\n```\npublic class CancellationTokenSource\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nCreates a new [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) or cancels one that has already created. There is a 1:1 `CancellationTokenSource` to [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) relationship.\n\nTo create a [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken), create a `CancellationTokenSource` first and then call [getToken](/android/reference/com/google/android/gms/tasks/CancellationTokenSource#getToken()) to get the [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) for this `\nCancellationTokenSource`. \n\n| See also |\n|----------------------------------------------------------------------------------------|---|\n| [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) | |\n\nSummary\n-------\n\n| ### Public constructors |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [CancellationTokenSource](/android/reference/com/google/android/gms/tasks/CancellationTokenSource#CancellationTokenSource())`()` Creates a new [CancellationTokenSource](/android/reference/com/google/android/gms/tasks/CancellationTokenSource) instance. |\n\n| ### Public methods |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `void` | [cancel](/android/reference/com/google/android/gms/tasks/CancellationTokenSource#cancel())`()` Cancels the [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) if cancellation has not been requested yet. |\n| `@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) | [getToken](/android/reference/com/google/android/gms/tasks/CancellationTokenSource#getToken())`()` Gets the [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) for this [CancellationTokenSource](/android/reference/com/google/android/gms/tasks/CancellationTokenSource). |\n\nPublic constructors\n-------------------\n\n### CancellationTokenSource\n\n```\npublic CancellationTokenSource()\n```\n\nCreates a new [CancellationTokenSource](/android/reference/com/google/android/gms/tasks/CancellationTokenSource) instance. \n\nPublic methods\n--------------\n\n### cancel\n\n```\npublic void cancel()\n```\n\nCancels the [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) if cancellation has not been requested yet. \n\n### getToken\n\n```\npublic @NonNull CancellationToken getToken()\n```\n\nGets the [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) for this [CancellationTokenSource](/android/reference/com/google/android/gms/tasks/CancellationTokenSource). \n\n| Returns |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `@`[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull.html)` `[CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) | the [CancellationToken](/android/reference/com/google/android/gms/tasks/CancellationToken) that can be passed to asynchronous [Task](/android/reference/com/google/android/gms/tasks/Task) to cancel the Task. |"]]
