Timeout with withTimeout in Kotlin - Mini Project: Build & Apply

Timeout with withTimeout

📖 Scenario: Imagine you are making a simple program that waits for a task to finish, but you don't want to wait forever. You want to stop waiting if it takes too long.

🎯 Goal: You will build a Kotlin program that uses withTimeout to stop waiting after a set time.

📋 What You'll Learn

Create a suspend function that simulates a long task

Set a timeout duration using withTimeout

Run the task inside withTimeout

Handle the timeout exception and print a message

💡 Why This Matters

🌍 Real World

Timeouts are useful when waiting for slow tasks like network calls or user input, so your program doesn't freeze or wait forever.

💼 Career

Many jobs require handling timeouts to keep apps responsive and avoid crashes, especially in mobile and backend development.

1

Create a suspend function to simulate a long task

Write a suspend function called longTask that waits for 3000 milliseconds using delay(3000).

Kotlin

# Write the suspend function longTask with delay(3000)
// Your code here

Hint

Use suspend fun to create a function that can pause. Use delay(3000) to wait 3 seconds.

2

Set a timeout duration using withTimeout

Create a val timeoutMillis and set it to 2000L to represent 2000 milliseconds timeout.

Kotlin

import kotlinx.coroutines.delay

suspend fun longTask() {
    delay(3000)
}

// Create a val timeoutMillis and set it to 2000L
// Your code here

Hint

Use val timeoutMillis = 2000L to set the timeout to 2 seconds.

3

Run the task inside withTimeout

Write a suspend function called runWithTimeout that uses withTimeout(timeoutMillis) to run longTask().

Kotlin

import kotlinx.coroutines.delay
import kotlinx.coroutines.withTimeout

suspend fun longTask() {
    delay(3000)
}

val timeoutMillis = 2000L

// Write suspend fun runWithTimeout that runs longTask inside withTimeout(timeoutMillis)
// Your code here

Hint

Use withTimeout(timeoutMillis) { longTask() } inside the new suspend function.

4

Handle timeout exception and print result

Write a main function that calls runBlocking and inside it calls runWithTimeout(). Catch TimeoutCancellationException and print "Timeout happened!". If no timeout, print "Task completed".

Kotlin

import kotlinx.coroutines.delay
import kotlinx.coroutines.withTimeout
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.TimeoutCancellationException

suspend fun longTask() {
    delay(3000)
}

val timeoutMillis = 2000L

suspend fun runWithTimeout() {
    withTimeout(timeoutMillis) {
        longTask()
    }
}

// Write main function with runBlocking
// Call runWithTimeout inside try-catch
// Print "Timeout happened!" if timeout exception
// Print "Task completed" if no exception
// Your code here

Hint

Use try { runWithTimeout() } and catch (e: TimeoutCancellationException) to print the timeout message.

Practice

1. What does the Kotlin function withTimeout do?

easy

A. It cancels all running coroutines immediately.

B. It repeats a block of code until a timeout occurs.

C. It stops a block of code if it runs longer than the specified time.

D. It delays the execution of a block for a fixed time.

Solution

1. Step 1: Understand the purpose of withTimeout

   withTimeout is designed to stop a block of code if it exceeds a given time limit.

2. Step 2: Compare options with the definition

   Only "It stops a block of code if it runs longer than the specified time." correctly describes this behavior. Other options describe different coroutine behaviors.

3. Final Answer:

   It stops a block of code if it runs longer than the specified time. -> Option C

4. Quick Check:

   withTimeout stops code after time limit [OK]

Hint: Remember: withTimeout interrupts long-running code [OK]

Common Mistakes:

• Confusing withTimeout with delay function
• Thinking it repeats code instead of stopping
• Assuming it cancels all coroutines globally

2. Which of the following is the correct syntax to use withTimeout in Kotlin?

easy

A. withTimeout(1000) { /* code block */ }

B. withTimeout { 1000, /* code block */ }

C. withTimeout[1000] { /* code block */ }

D. withTimeout: 1000 { /* code block */ }

Solution

1. Step 1: Recall the function signature

   The correct syntax uses parentheses with the timeout in milliseconds as the first argument, followed by a lambda block.

2. Step 2: Match options with correct syntax

   withTimeout(1000) { /* code block */ } matches this pattern exactly. Others use incorrect brackets or misplaced arguments.

3. Final Answer:

   withTimeout(1000) { /* code block */ } -> Option A

4. Quick Check:

   withTimeout uses parentheses for timeout [OK]

Hint: Use parentheses with timeout value before code block [OK]

Common Mistakes:

• Using square brackets instead of parentheses
• Placing timeout inside the block instead of argument
• Using colon instead of parentheses

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

import kotlinx.coroutines.*

fun main() = runBlocking {
    try {
        withTimeout(100) {
            repeat(5) { i ->
                println("Processing $i")
                delay(50)
            }
        }
    } catch (e: TimeoutCancellationException) {
        println("Timeout occurred")
    }
}

medium

A. Processing 0
Processing 1
Processing 2
Processing 3
Processing 4

B. Processing 0
Processing 1
Timeout occurred

C. Timeout occurred

D. Processing 0
Timeout occurred
Processing 1

Solution

1. Step 1: Analyze the timing of the loop and timeout

   Each iteration delays 50ms. After two iterations, 100ms timeout is reached.

2. Step 2: Determine output before timeout

   "Processing 0" and "Processing 1" print before timeout triggers. Then exception is caught and "Timeout occurred" prints.

3. Final Answer:

   Processing 0 Processing 1 Timeout occurred -> Option B

4. Quick Check:

   Timeout stops after 2 prints + exception message [OK]

Hint: Multiply delay by iterations to compare with timeout [OK]

Common Mistakes:

• Assuming all iterations print before timeout
• Ignoring exception catch block
• Thinking timeout cancels immediately without partial output

4. Identify the error in this Kotlin code using withTimeout:

import kotlinx.coroutines.*

fun main() = runBlocking {
    withTimeout(100) {
        delay(200)
        println("Done")
    }
}

medium

A. TimeoutCancellationException is thrown because delay exceeds timeout.

B. Syntax error: withTimeout requires a try-catch block.

C. No error; code runs and prints "Done" after 200ms.

D. Delay function cannot be used inside withTimeout.

Solution

1. Step 1: Understand withTimeout behavior with delay

   The delay of 200ms exceeds the 100ms timeout, causing a TimeoutCancellationException.

2. Step 2: Check error handling

   No try-catch is present, so exception will be thrown and program will crash.

3. Final Answer:

   TimeoutCancellationException is thrown because delay exceeds timeout. -> Option A

4. Quick Check:

   Delay longer than timeout causes exception [OK]

Hint: Delay longer than timeout causes exception unless caught [OK]

Common Mistakes:

• Assuming code waits full delay then prints
• Thinking try-catch is mandatory syntax
• Believing delay can't be used inside withTimeout

5. You want to run a network request that should timeout after 500ms. Which Kotlin code correctly uses withTimeout to achieve this and handle timeout gracefully?

hard

A. try {
networkRequest()
withTimeout(500)
} catch (e: TimeoutCancellationException) {
println("Request timed out")
}

B. withTimeout(500) {
try {
networkRequest()
} catch (e: TimeoutCancellationException) {
println("Request timed out")
}
}

C. withTimeoutOrNull(500) {
networkRequest()
} ?: println("Request timed out")

D. try {
withTimeout(500) {
networkRequest()
}
} catch (e: TimeoutCancellationException) {
println("Request timed out")
}

Solution

1. Step 1: Understand correct placement of withTimeout and try-catch

   The timeout should wrap the networkRequest call, and the exception should be caught outside to handle timeout.

2. Step 2: Evaluate options for proper structure

   try { withTimeout(500) { networkRequest() } } catch (e: TimeoutCancellationException) { println("Request timed out") } correctly wraps networkRequest inside withTimeout and catches the exception outside. withTimeout(500) { try { networkRequest() } catch (e: TimeoutCancellationException) { println("Request timed out") } } catches inside, which won't catch timeout. withTimeoutOrNull(500) { networkRequest() } ?: println("Request timed out") uses withTimeoutOrNull (valid but different). try { networkRequest() withTimeout(500) } catch (e: TimeoutCancellationException) { println("Request timed out") } misplaces withTimeout after networkRequest.

3. Final Answer:

   try { withTimeout(500) { networkRequest() } } catch (e: TimeoutCancellationException) { println("Request timed out") } -> Option D

4. Quick Check:

   Wrap withTimeout around call, catch outside [OK]

Hint: Wrap withTimeout around call, catch exception outside [OK]

Common Mistakes:

• Catching exception inside withTimeout block
• Placing withTimeout after the call
• Confusing withTimeout with withTimeoutOrNull