hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-27 16:57:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Clarify the role of Dispatchers.Main in 2025.1 (#1429)

Browse Source 
* Clarify the role of `Dispatchers.Main` in 2025.1

* Update topics/basics/architectural_overview/threading/coroutines/coroutine_dispatchers.md

* Update topics/basics/architectural_overview/threading/coroutines/coroutine_dispatchers.md

Co-authored-by: Karol Lewandowski <karol86@gmail.com>

* Update topics/basics/architectural_overview/threading/coroutines/coroutine_dispatchers.md

Co-authored-by: Karol Lewandowski <karol86@gmail.com>

---------

Co-authored-by: Karol Lewandowski <karol86@gmail.com>
This commit is contained in:
Konstantin Nisht 2025-02-26 18:07:05 +01:00 committed by GitHub
parent 8e75908ed2
commit 0870bf885d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
topics/basics/architectural_overview/threading/coroutines/coroutine_dispatchers.md
View File

@ -63,7 +63,25 @@ The [`Dispatchers.EDT`](%gh-ic%/platform/core-api/src/com/intellij/openapi/appli
### `Dispatchers.Main` vs. `Dispatchers.EDT`
In Kotlin, a standard dispatcher for UI-based activities is [`Dispatchers.Main`](https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-dispatchers/-main.html).
<tabs>
<tab title="2025.1+">
In the IntelliJ Platform, `Dispatchers.Main` differs from `Dispatchers.EDT`:
1. It is forbidden to initiate read or write actions in `Dispatchers.Main`.
`Dispatchers.Main` is a pure UI dispatcher, and accidental access to the IntelliJ Platform model could cause UI freezes.
2. `Dispatchers.Main` uses `any` [modality state](threading_model.md#invoking-operations-on-edt-and-modality) if it cannot infer modality from the coroutine context.
This helps to ensure progress guarantees in libraries that use `Dispatchers.Main`.
</tab>
<tab title="Earlier versions">
In the IntelliJ Platform, the EDT dispatcher is also installed as `Dispatchers.Main` so both can be used, however always prefer `Dispatchers.EDT`.
</tab>
</tabs>
Use `Dispatchers.Main` only if the coroutine is IntelliJ Platform-context agnostic (e.g., when it can be executed outside the IntelliJ Platform context).
Use `Dispatchers.EDT` when in doubt.