When to Dispose CancellationTokenSource in Xamarin.Forms Async Operations?

Lifecycle Management for CancellationTokenSource

A CancellationTokenSource (CTS) should be disposed of as soon as it is no longer needed to release internal timer resources and kernel handles. The timing of disposal depends on the scope of the operation:

• Single-use operations: Dispose of the CTS immediately after the task completes or is cancelled, ideally within a finally block.
• Page-level operations: If a CTS is used to cancel all pending requests when a user navigates away, maintain it as a class-level field and dispose of it during the page's cleanup phase (e.g., overriding OnDisappearing).

HttpClient and Token Respect

The default HttpClient implementation in Xamarin.Forms respects the CancellationToken passed to methods like GetAsync. When the token is triggered, the client aborts the network request and throws an OperationCanceledException. This allows the application to stop waiting for a response and free up the connection.

Patterns to Prevent Memory Leaks

To avoid memory leaks and handle overlapping requests (such as a user clicking a "Refresh" button multiple times), use a Cancel-and-Replace pattern. This ensures only one request is active at a time without leaking previous CTS instances.

private CancellationTokenSource _cts;

public async Task LoadDataAsync()
{
    // Cancel the previous operation if it exists
    _cts?.Cancel();
    _cts?.Dispose();

    _cts = new CancellationTokenSource();

    try
    {
        var result = await _httpClient.GetAsync(url, _cts.Token);
        // Process result
    }
    catch (OperationCanceledException)
    {
        // Handle cancellation (e.g., ignore or log)
    }
    finally
    {
        // Only dispose here if this was a one-off request
        // and not managed by the class-level _cts
    }
}

Verification Steps

• Exception Handling: Verify that OperationCanceledException is thrown when the token is triggered during an active HttpClient.GetAsync call.
• Resource Cleanup: Use a memory profiler to confirm that CancellationTokenSource instances are garbage collected after the page is popped from the navigation stack.
• Concurrency Test: Trigger rapid successive requests to ensure previous operations are aborted and their associated resources are released.

Diagnostic Detail Needed: Are you using a custom HttpMessageHandler (such as a native Android/iOS handler) or a third-party wrapper around HttpClient? Some custom handlers may exhibit different cancellation behaviors.