What does the suspend function mean in a Kotlin Coroutine?

by

Suspending functions are at the center of everything coroutines.
A suspending function is simply a function that can be paused and resumed at a later time. They can execute a long running operation and wait for it to complete without blocking.

The syntax of a suspending function is similar to that of a regular function except for the addition of the suspend keyword. It can take a parameter and have a return type. However, suspending functions can only be invoked by another suspending function or within a coroutine.

suspend fun backgroundTask(param: Int): Int {
     // long running operation
}

Under the hood, suspend functions are converted by the compiler to another function without the suspend keyword, that takes an addition parameter of type Continuation<T>. The function above for example, will be converted by the compiler to this:

fun backgroundTask(param: Int, callback: Continuation<Int>): Int {
   // long running operation
}

Continuation<T> is an interface that contains two functions that are invoked to resume the coroutine with a return value or with an exception if an error had occurred while the function was suspended.

interface Continuation<in T> {
   val context: CoroutineContext
   fun resume(value: T)
   fun resumeWithException(exception: Throwable)
}

More Related Contents:

  1. Why not use GlobalScope.launch?
  2. How to make “inappropriate blocking method call” appropriate?
  3. Coroutines: runBlocking vs coroutineScope
  4. The AsyncTask API is deprecated in Android 11. What are the alternatives?
  5. How to write ternary conditional operator?
  6. Kotlin: how to pass a function as parameter to another?
  7. What does ?: do in Kotlin? (Elvis Operator)
  8. What is the difference between launch/join and async/await in Kotlin coroutines
  9. Is Kotlin “pass-by-value” or “pass-by-reference”?
  10. What is the Kotlin double-bang (!!) operator?
  11. Multiple variable let in Kotlin
  12. How can I detect a click with the view behind a Jetpack Compose Button?
  13. When should one prefer Kotlin extension functions?
  14. How to create a fat JAR with Gradle Kotlin script?
  15. how to run compiled class file in Kotlin?
  16. Getters and Setters in Kotlin
  17. Why does mutableStateOf without remember work sometimes?
  18. IntArray vs Array in Kotlin
  19. How to clone object in Kotlin?
  20. Override getter for Kotlin data class
  21. Sort collection by multiple fields in Kotlin [duplicate]
  22. How can one add static methods to Java classes in Kotlin
  23. Kotlin doesn’t see Java Lombok accessors?
  24. Building a self-executable JAR with Gradle and Kotlin
  25. 0xFF0000FF An integer literal does not conform to the expected type kotlin.Int
  26. What does .() mean in Kotlin?
  27. AsyncTask as kotlin coroutine
  28. How can I debounce a setOnClickListener for 1 second using Kotlin Coroutines?
  29. Kotlin Ternary Conditional Operator
  30. How to implement timer with Kotlin coroutines

Leave a Comment