CancellationException behavior in Kotlin

Introduction

CancellationException helps stop a running task cleanly when you want to cancel it.

You want to stop a background task when the user leaves a screen.

You want to cancel a long-running operation if it takes too long.

You want to clean up resources when a coroutine is cancelled.

You want to handle cancellation without treating it as an error.

Syntax

Kotlin

throw CancellationException("message")

This exception is special for coroutine cancellation.

It does not show as an error but as a normal cancellation.

Examples

Throwing a CancellationException with a message.

Kotlin

throw CancellationException("Job was cancelled")

Catch CancellationException to handle cancellation gracefully.

Kotlin

try {
    // some coroutine work
} catch (e: CancellationException) {
    println("Cancelled cleanly")
}

Sample Program

This program launches a coroutine that works in steps. After some time, it cancels the coroutine with a CancellationException. The coroutine catches this exception and cleans up.

Kotlin

import kotlinx.coroutines.*

fun main() = runBlocking {
    val job = launch {
        try {
            repeat(5) { i ->
                println("Working on task $i...")
                delay(500)
            }
        } catch (e: CancellationException) {
            println("Coroutine was cancelled: " + e.message)
            throw e
        } finally {
            println("Cleanup after cancellation")
        }
    }

    delay(1100) // Let it work a bit
    println("Cancelling the job")
    job.cancel(CancellationException("User requested cancellation"))
    job.join()
    println("Done")
}

Important Notes

CancellationException is used internally by coroutines to stop work without errors.

Always handle CancellationException if you want to clean up resources.

Throwing CancellationException signals cooperative cancellation.

Summary

CancellationException stops coroutines cleanly without error.

Use it to cancel tasks and handle cleanup.

Catch it to avoid treating cancellation as a failure.

Practice

1. What is the primary purpose of CancellationException in Kotlin coroutines?

easy

A. To stop coroutines cleanly without treating it as an error

B. To indicate a syntax error in coroutine code

C. To force a coroutine to restart automatically

D. To log coroutine execution details

Solution

1. Step 1: Understand coroutine cancellation

   CancellationException is used to stop coroutines without throwing an error that crashes the program.

2. Step 2: Differentiate from errors

   Unlike other exceptions, CancellationException signals a normal cancellation, not a failure.

3. Final Answer:

   To stop coroutines cleanly without treating it as an error -> Option A

4. Quick Check:

   CancellationException stops coroutines cleanly [OK]

Hint: CancellationException means clean stop, not error [OK]

Common Mistakes:

• Confusing it with runtime errors
• Thinking it restarts coroutines
• Assuming it logs info automatically

2. Which of the following is the correct way to catch a CancellationException in Kotlin?

easy

A. catch (Error e) { /* handle */ }

B. catch (Exception e) { /* handle */ }

C. catch (Throwable e) { /* handle */ }

D. catch (CancellationException e) { /* handle */ }

Solution

1. Step 1: Identify exception type

   CancellationException is a specific exception type used for coroutine cancellation.

2. Step 2: Use specific catch block

   To handle cancellation properly, catch CancellationException explicitly.

3. Final Answer:

   catch (CancellationException e) { /* handle */ } -> Option D

4. Quick Check:

   Catch CancellationException explicitly [OK]

Hint: Catch CancellationException by its own type [OK]

Common Mistakes:

• Catching only Exception hides cancellation
• Using catch (Error) which is unrelated
• Catching Throwable catches too broadly

3. What will be the output of this Kotlin coroutine code snippet?

import kotlinx.coroutines.*

fun main() = runBlocking {
    val job = launch {
        try {
            repeat(3) { i ->
                println("Working $i...")
                delay(100)
            }
        } catch (e: CancellationException) {
            println("Cancelled!")
        } finally {
            println("Cleanup done.")
        }
    }
    delay(150)
    job.cancelAndJoin()
    println("Done")
}

medium

A. Working 0...
Working 1...
Cancelled!
Cleanup done.
Done

B. Working 0...
Working 1...
Working 2...
Done

C. Cancelled!
Cleanup done.
Done

D. Working 0...
Cancelled!
Done

Solution

1. Step 1: Trace coroutine execution and cancellation

   The coroutine prints "Working 0..." and "Working 1..." with 100ms delay each, then cancellation occurs after 150ms.

2. Step 2: Handle CancellationException and finally block

   CancellationException is caught, printing "Cancelled!" and finally block prints "Cleanup done." before main prints "Done".

3. Final Answer:

   Working 0... Working 1... Cancelled! Cleanup done. Done -> Option A

4. Quick Check:

   CancellationException caught, cleanup runs, then Done [OK]

Hint: CancellationException triggers catch and finally blocks [OK]

Common Mistakes:

• Ignoring finally block output
• Assuming all repeats run before cancel
• Missing cancellation catch output

4. Identify the problem in this Kotlin coroutine snippet that tries to handle cancellation:

val job = launch {
    try {
        delay(1000)
    } catch (e: Exception) {
        println("Cancelled")
    }
}
job.cancel()

medium

A. The coroutine never starts because launch is missing parentheses

B. Calling job.cancel() without join causes a deadlock

C. It catches Exception instead of CancellationException, so cancellation is not handled properly

D. delay(1000) cannot be cancelled

Solution

1. Step 1: Check exception handling

   The catch block catches Exception, which includes CancellationException but does not distinguish it from other exceptions.

2. Step 2: Understand cancellation propagation

   To specifically handle cancellation without catching unrelated exceptions, catch CancellationException explicitly.

3. Final Answer:

   It catches Exception instead of CancellationException, so cancellation is not handled properly -> Option C

4. Quick Check:

   Catch CancellationException explicitly to handle cancellation [OK]

Hint: Catch CancellationException, not just Exception [OK]

Common Mistakes:

• Assuming Exception catch handles cancellation
• Thinking delay is uncancellable
• Confusing cancel() with deadlock

5. You want to cancel a coroutine but still perform some cleanup code without treating cancellation as an error. Which pattern correctly uses CancellationException to achieve this?

hard

A. Avoid catching exceptions and rely on coroutine scope cancellation only

B. Use try-catch with catch (CancellationException) to handle cancellation and run cleanup in finally

C. Use a global exception handler to catch all exceptions including cancellation

D. Use try-catch with catch (Exception) and ignore finally block

Solution

1. Step 1: Understand cancellation handling best practice

   CancellationException should be caught explicitly to avoid treating cancellation as failure.

2. Step 2: Use finally block for cleanup

   Cleanup code belongs in finally to ensure it runs whether coroutine completes or is cancelled.

3. Final Answer:

   Use try-catch with catch (CancellationException) to handle cancellation and run cleanup in finally -> Option B

4. Quick Check:

   Catch CancellationException and cleanup in finally [OK]

Hint: Catch CancellationException and cleanup in finally block [OK]

Common Mistakes:

• Catching only Exception hides cancellation
• Skipping finally block for cleanup
• Relying on global handlers for cancellation