SharedFlow in Kotlin

Introduction

SharedFlow is a fundamental concept every Kotlin developer should understand. Flow streams values over time, similar to RxJava observables but with structured concurrency and coroutine integration.

SharedFlow emits events to multiple collectors. In this tutorial you will learn the syntax, walk through a complete example program, study the sample output, and review best practices so you can apply the concept confidently in your own projects.

Definition

• SharedFlow emits events to multiple collectors.
• It can replay recent values based on configuration.
• Useful for one-time events and broadcasts.

Syntax

MutableSharedFlow()

SharedFlow in Kotlin Example Program in Kotlin

import kotlinx.coroutines.*
import kotlinx.coroutines.flow.*

fun main(args: Array<String>) = runBlocking {
    val events = MutableSharedFlow<String>(replay = 1)
    val job = launch {
        events.collect { println("Received: $it") }
    }
    events.emit("Updated")
    job.cancel()
}

Sample Output

Received: Updated

When to use

Use Flow for streams of values over time — sensor readings, paginated API pages, or search-as-you-type results.

How it works

1. The program starts with a main function — the entry point that runs when you execute the file.

2. val events = MutableSharedFlow<String>(replay = 1) assigns or updates a value used later in the program.

3. val job = launch { assigns or updates a value used later in the program.

4. The println("Received: $it") statement writes a line to the console — this produces part of the sample output below.

5. SharedFlow emits events to multiple collectors.

6. Run the program in IntelliJ IDEA, Android Studio, or with the Kotlin command-line compiler (kotlinc / kotlin). Compare your console output with the sample output shown below.

Best Practices

Common Mistakes

Key Points

• SharedFlow emits events to multiple collectors.
• It can replay recent values based on configuration.
• Useful for one-time events and broadcasts.
• Test the example locally and verify the output matches the sample.
• Experiment by changing input values to see how behaviour changes.

Notes

• Add the kotlinx-coroutines-core dependency when running coroutine examples outside Android or IntelliJ.
• Semicolons at the end of statements are optional in Kotlin.