withTimeout()

Another function that behaves a lot like coroutineScope is withTimeout. It also creates a scope and returns a value. Actually, withTimeout with a very big timeout behaves just like coroutineScope. The difference is that withTimeout additionally sets a time limit for its body execution. If it takes too long, it cancels this body and throws TimeoutCancellationException (a subtype of CancellationException).

Beware that withTimeout throws TimeoutCancellationException, which is a subtype of CancellationException (the same exception that is thrown when a coroutine is cancelled). So, when this exception is thrown in a coroutine builder, it only cancels it and does not affect its parent (as explained in the previous chapter). - Kotlin Coroutines Deep Dive

Relationships

• rel.similar-to (Private):coroutineScope (Function)

Gotchas

---

Children

1. withTimeout gotchas
2. ⚠️ does-not-cancel-parent-or-siblings-on-timeout ⚠️

---

Backlinks

• runTest & TestScope (virtualized-time in tests)
• Coroutine scope function instances