• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Module kotlinx-coroutines-reactor
2
3Utilities for [Reactor](https://projectreactor.io).
4
5Coroutine builders:
6
7| **Name**        | **Result**                            | **Scope**        | **Description**
8| --------------- | -------------------------------------- | ---------------- | ---------------
9| [mono]          | `Mono`                                 | [CoroutineScope] | Cold mono that starts coroutine on subscribe
10| [flux]          | `Flux`                                 | [CoroutineScope] | Cold flux that starts coroutine on subscribe
11
12Note that `Mono` and `Flux` are a subclass of [Reactive Streams](https://www.reactive-streams.org)
13`Publisher` and extensions for it are covered by
14[kotlinx-coroutines-reactive](../kotlinx-coroutines-reactive) module.
15
16Conversion functions:
17
18| **Name** | **Description**
19| -------- | ---------------
20| [Job.asMono][kotlinx.coroutines.Job.asMono] | Converts job to hot mono
21| [Deferred.asMono][kotlinx.coroutines.Deferred.asMono] | Converts deferred value to hot mono
22| [ReceiveChannel.asFlux][kotlinx.coroutines.channels.ReceiveChannel.asFlux] | Converts streaming channel to hot flux
23| [Scheduler.asCoroutineDispatcher][reactor.core.scheduler.Scheduler.asCoroutineDispatcher] | Converts scheduler to [CoroutineDispatcher]
24
25<!--- MODULE kotlinx-coroutines-core -->
26<!--- INDEX kotlinx.coroutines -->
27[CoroutineScope]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-scope/index.html
28[CoroutineDispatcher]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/-coroutine-dispatcher/index.html
29<!--- INDEX kotlinx.coroutines.channels -->
30<!--- MODULE kotlinx-coroutines-reactor -->
31<!--- INDEX kotlinx.coroutines.reactor -->
32[mono]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-reactor/kotlinx.coroutines.reactor/mono.html
33[flux]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-reactor/kotlinx.coroutines.reactor/flux.html
34[kotlinx.coroutines.Job.asMono]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-reactor/kotlinx.coroutines.reactor/kotlinx.coroutines.-job/as-mono.html
35[kotlinx.coroutines.Deferred.asMono]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-reactor/kotlinx.coroutines.reactor/kotlinx.coroutines.-deferred/as-mono.html
36[kotlinx.coroutines.channels.ReceiveChannel.asFlux]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-reactor/kotlinx.coroutines.reactor/kotlinx.coroutines.channels.-receive-channel/as-flux.html
37[reactor.core.scheduler.Scheduler.asCoroutineDispatcher]: https://kotlin.github.io/kotlinx.coroutines/kotlinx-coroutines-reactor/kotlinx.coroutines.reactor/reactor.core.scheduler.-scheduler/as-coroutine-dispatcher.html
38<!--- END -->
39
40# Package kotlinx.coroutines.reactor
41
42Utilities for [Reactor](https://projectreactor.io).
43