blob: ea512ba68d4ca35a119c9f459cb6fb012214e3a5 [file] [log] [blame] [view]
hadihariri7db55532018-09-15 10:35:08 +02001The main coroutines guide has moved to the [docs folder](docs/coroutines-guide.md) and split up into smaller documents.
Roman Elizarov715acd32018-10-08 20:20:12 +03002
3## Table of contents
4
5<!--- TOC_REF docs/basics.md -->
Roman Elizarov3258e1f2019-08-22 20:08:48 +03006* <a name='coroutine-basics'></a>[Coroutine Basics](docs/basics.md#coroutine-basics)
Roman Elizarov715acd32018-10-08 20:20:12 +03007 * <a name='your-first-coroutine'></a>[Your first coroutine](docs/basics.md#your-first-coroutine)
8 * <a name='bridging-blocking-and-non-blocking-worlds'></a>[Bridging blocking and non-blocking worlds](docs/basics.md#bridging-blocking-and-non-blocking-worlds)
9 * <a name='waiting-for-a-job'></a>[Waiting for a job](docs/basics.md#waiting-for-a-job)
10 * <a name='structured-concurrency'></a>[Structured concurrency](docs/basics.md#structured-concurrency)
11 * <a name='scope-builder'></a>[Scope builder](docs/basics.md#scope-builder)
12 * <a name='extract-function-refactoring'></a>[Extract function refactoring](docs/basics.md#extract-function-refactoring)
13 * <a name='coroutines-are-light-weight'></a>[Coroutines ARE light-weight](docs/basics.md#coroutines-are-light-weight)
14 * <a name='global-coroutines-are-like-daemon-threads'></a>[Global coroutines are like daemon threads](docs/basics.md#global-coroutines-are-like-daemon-threads)
15<!--- TOC_REF docs/cancellation-and-timeouts.md -->
Roman Elizarov3258e1f2019-08-22 20:08:48 +030016* <a name='cancellation-and-timeouts'></a>[Cancellation and Timeouts](docs/cancellation-and-timeouts.md#cancellation-and-timeouts)
Roman Elizarov715acd32018-10-08 20:20:12 +030017 * <a name='cancelling-coroutine-execution'></a>[Cancelling coroutine execution](docs/cancellation-and-timeouts.md#cancelling-coroutine-execution)
18 * <a name='cancellation-is-cooperative'></a>[Cancellation is cooperative](docs/cancellation-and-timeouts.md#cancellation-is-cooperative)
19 * <a name='making-computation-code-cancellable'></a>[Making computation code cancellable](docs/cancellation-and-timeouts.md#making-computation-code-cancellable)
Pavel Semyonove3030e32019-05-06 14:26:16 +070020 * <a name='closing-resources-with-finally'></a>[Closing resources with `finally`](docs/cancellation-and-timeouts.md#closing-resources-with-finally)
Roman Elizarov715acd32018-10-08 20:20:12 +030021 * <a name='run-non-cancellable-block'></a>[Run non-cancellable block](docs/cancellation-and-timeouts.md#run-non-cancellable-block)
22 * <a name='timeout'></a>[Timeout](docs/cancellation-and-timeouts.md#timeout)
23<!--- TOC_REF docs/composing-suspending-functions.md -->
Roman Elizarov3258e1f2019-08-22 20:08:48 +030024* <a name='composing-suspending-functions'></a>[Composing Suspending Functions](docs/composing-suspending-functions.md#composing-suspending-functions)
Roman Elizarov715acd32018-10-08 20:20:12 +030025 * <a name='sequential-by-default'></a>[Sequential by default](docs/composing-suspending-functions.md#sequential-by-default)
26 * <a name='concurrent-using-async'></a>[Concurrent using async](docs/composing-suspending-functions.md#concurrent-using-async)
27 * <a name='lazily-started-async'></a>[Lazily started async](docs/composing-suspending-functions.md#lazily-started-async)
28 * <a name='async-style-functions'></a>[Async-style functions](docs/composing-suspending-functions.md#async-style-functions)
29 * <a name='structured-concurrency-with-async'></a>[Structured concurrency with async](docs/composing-suspending-functions.md#structured-concurrency-with-async)
30<!--- TOC_REF docs/coroutine-context-and-dispatchers.md -->
Roman Elizarov3258e1f2019-08-22 20:08:48 +030031* <a name='coroutine-context-and-dispatchers'></a>[Coroutine Context and Dispatchers](docs/coroutine-context-and-dispatchers.md#coroutine-context-and-dispatchers)
Roman Elizarov715acd32018-10-08 20:20:12 +030032 * <a name='dispatchers-and-threads'></a>[Dispatchers and threads](docs/coroutine-context-and-dispatchers.md#dispatchers-and-threads)
33 * <a name='unconfined-vs-confined-dispatcher'></a>[Unconfined vs confined dispatcher](docs/coroutine-context-and-dispatchers.md#unconfined-vs-confined-dispatcher)
34 * <a name='debugging-coroutines-and-threads'></a>[Debugging coroutines and threads](docs/coroutine-context-and-dispatchers.md#debugging-coroutines-and-threads)
katia-energizerabc6cd82020-08-12 16:51:36 +030035 * <a name='debugging-with-idea'></a>[Debugging with IDEA](docs/coroutine-context-and-dispatchers.md#debugging-with-idea)
36 * <a name='debugging-using-logging'></a>[Debugging using logging](docs/coroutine-context-and-dispatchers.md#debugging-using-logging)
Roman Elizarov715acd32018-10-08 20:20:12 +030037 * <a name='jumping-between-threads'></a>[Jumping between threads](docs/coroutine-context-and-dispatchers.md#jumping-between-threads)
38 * <a name='job-in-the-context'></a>[Job in the context](docs/coroutine-context-and-dispatchers.md#job-in-the-context)
39 * <a name='children-of-a-coroutine'></a>[Children of a coroutine](docs/coroutine-context-and-dispatchers.md#children-of-a-coroutine)
40 * <a name='parental-responsibilities'></a>[Parental responsibilities](docs/coroutine-context-and-dispatchers.md#parental-responsibilities)
41 * <a name='naming-coroutines-for-debugging'></a>[Naming coroutines for debugging](docs/coroutine-context-and-dispatchers.md#naming-coroutines-for-debugging)
42 * <a name='combining-context-elements'></a>[Combining context elements](docs/coroutine-context-and-dispatchers.md#combining-context-elements)
Vsevolod Tolstopyatove9123ca2019-03-01 15:40:16 +030043 * <a name='coroutine-scope'></a>[Coroutine scope](docs/coroutine-context-and-dispatchers.md#coroutine-scope)
Roman Elizarov715acd32018-10-08 20:20:12 +030044 * <a name='thread-local-data'></a>[Thread-local data](docs/coroutine-context-and-dispatchers.md#thread-local-data)
Roman Elizarov3258e1f2019-08-22 20:08:48 +030045<!--- TOC_REF docs/flow.md -->
46* <a name='asynchronous-flow'></a>[Asynchronous Flow](docs/flow.md#asynchronous-flow)
47 * <a name='representing-multiple-values'></a>[Representing multiple values](docs/flow.md#representing-multiple-values)
48 * <a name='sequences'></a>[Sequences](docs/flow.md#sequences)
49 * <a name='suspending-functions'></a>[Suspending functions](docs/flow.md#suspending-functions)
50 * <a name='flows'></a>[Flows](docs/flow.md#flows)
51 * <a name='flows-are-cold'></a>[Flows are cold](docs/flow.md#flows-are-cold)
Roman Elizarov9bbb6692020-06-03 12:02:17 +030052 * <a name='flow-cancellation-basics'></a>[Flow cancellation basics](docs/flow.md#flow-cancellation-basics)
Roman Elizarov3258e1f2019-08-22 20:08:48 +030053 * <a name='flow-builders'></a>[Flow builders](docs/flow.md#flow-builders)
54 * <a name='intermediate-flow-operators'></a>[Intermediate flow operators](docs/flow.md#intermediate-flow-operators)
55 * <a name='transform-operator'></a>[Transform operator](docs/flow.md#transform-operator)
56 * <a name='size-limiting-operators'></a>[Size-limiting operators](docs/flow.md#size-limiting-operators)
57 * <a name='terminal-flow-operators'></a>[Terminal flow operators](docs/flow.md#terminal-flow-operators)
58 * <a name='flows-are-sequential'></a>[Flows are sequential](docs/flow.md#flows-are-sequential)
59 * <a name='flow-context'></a>[Flow context](docs/flow.md#flow-context)
60 * <a name='wrong-emission-withcontext'></a>[Wrong emission withContext](docs/flow.md#wrong-emission-withcontext)
61 * <a name='flowon-operator'></a>[flowOn operator](docs/flow.md#flowon-operator)
62 * <a name='buffering'></a>[Buffering](docs/flow.md#buffering)
63 * <a name='conflation'></a>[Conflation](docs/flow.md#conflation)
64 * <a name='processing-the-latest-value'></a>[Processing the latest value](docs/flow.md#processing-the-latest-value)
65 * <a name='composing-multiple-flows'></a>[Composing multiple flows](docs/flow.md#composing-multiple-flows)
66 * <a name='zip'></a>[Zip](docs/flow.md#zip)
67 * <a name='combine'></a>[Combine](docs/flow.md#combine)
68 * <a name='flattening-flows'></a>[Flattening flows](docs/flow.md#flattening-flows)
69 * <a name='flatmapconcat'></a>[flatMapConcat](docs/flow.md#flatmapconcat)
70 * <a name='flatmapmerge'></a>[flatMapMerge](docs/flow.md#flatmapmerge)
71 * <a name='flatmaplatest'></a>[flatMapLatest](docs/flow.md#flatmaplatest)
72 * <a name='flow-exceptions'></a>[Flow exceptions](docs/flow.md#flow-exceptions)
73 * <a name='collector-try-and-catch'></a>[Collector try and catch](docs/flow.md#collector-try-and-catch)
74 * <a name='everything-is-caught'></a>[Everything is caught](docs/flow.md#everything-is-caught)
75 * <a name='exception-transparency'></a>[Exception transparency](docs/flow.md#exception-transparency)
76 * <a name='transparent-catch'></a>[Transparent catch](docs/flow.md#transparent-catch)
77 * <a name='catching-declaratively'></a>[Catching declaratively](docs/flow.md#catching-declaratively)
78 * <a name='flow-completion'></a>[Flow completion](docs/flow.md#flow-completion)
79 * <a name='imperative-finally-block'></a>[Imperative finally block](docs/flow.md#imperative-finally-block)
80 * <a name='declarative-handling'></a>[Declarative handling](docs/flow.md#declarative-handling)
Roman Elizaroveb4e7d32020-04-27 15:04:00 +030081 * <a name='successful-completion'></a>[Successful completion](docs/flow.md#successful-completion)
Roman Elizarove95d8082019-08-26 19:16:23 +030082 * <a name='imperative-versus-declarative'></a>[Imperative versus declarative](docs/flow.md#imperative-versus-declarative)
Roman Elizarov3258e1f2019-08-22 20:08:48 +030083 * <a name='launching-flow'></a>[Launching flow](docs/flow.md#launching-flow)
Roman Elizarov9bbb6692020-06-03 12:02:17 +030084 * <a name='flow-cancellation-checks'></a>[Flow cancellation checks](docs/flow.md#flow-cancellation-checks)
85 * <a name='making-busy-flow-cancellable'></a>[Making busy flow cancellable](docs/flow.md#making-busy-flow-cancellable)
Vsevolod Tolstopyatovc99704a2019-09-24 19:30:49 +030086 * <a name='flow-and-reactive-streams'></a>[Flow and Reactive Streams](docs/flow.md#flow-and-reactive-streams)
Roman Elizarov715acd32018-10-08 20:20:12 +030087<!--- TOC_REF docs/channels.md -->
Roman Elizarov3ed7a7d2019-06-17 20:54:16 -070088* <a name='channels'></a>[Channels](docs/channels.md#channels)
Roman Elizarov715acd32018-10-08 20:20:12 +030089 * <a name='channel-basics'></a>[Channel basics](docs/channels.md#channel-basics)
90 * <a name='closing-and-iteration-over-channels'></a>[Closing and iteration over channels](docs/channels.md#closing-and-iteration-over-channels)
91 * <a name='building-channel-producers'></a>[Building channel producers](docs/channels.md#building-channel-producers)
92 * <a name='pipelines'></a>[Pipelines](docs/channels.md#pipelines)
93 * <a name='prime-numbers-with-pipeline'></a>[Prime numbers with pipeline](docs/channels.md#prime-numbers-with-pipeline)
94 * <a name='fan-out'></a>[Fan-out](docs/channels.md#fan-out)
95 * <a name='fan-in'></a>[Fan-in](docs/channels.md#fan-in)
96 * <a name='buffered-channels'></a>[Buffered channels](docs/channels.md#buffered-channels)
97 * <a name='channels-are-fair'></a>[Channels are fair](docs/channels.md#channels-are-fair)
98 * <a name='ticker-channels'></a>[Ticker channels](docs/channels.md#ticker-channels)
Roman Elizarov3258e1f2019-08-22 20:08:48 +030099<!--- TOC_REF docs/exception-handling.md -->
100* <a name='exception-handling'></a>[Exception Handling](docs/exception-handling.md#exception-handling)
101 * <a name='exception-propagation'></a>[Exception propagation](docs/exception-handling.md#exception-propagation)
102 * <a name='coroutineexceptionhandler'></a>[CoroutineExceptionHandler](docs/exception-handling.md#coroutineexceptionhandler)
103 * <a name='cancellation-and-exceptions'></a>[Cancellation and exceptions](docs/exception-handling.md#cancellation-and-exceptions)
104 * <a name='exceptions-aggregation'></a>[Exceptions aggregation](docs/exception-handling.md#exceptions-aggregation)
105 * <a name='supervision'></a>[Supervision](docs/exception-handling.md#supervision)
106 * <a name='supervision-job'></a>[Supervision job](docs/exception-handling.md#supervision-job)
107 * <a name='supervision-scope'></a>[Supervision scope](docs/exception-handling.md#supervision-scope)
108 * <a name='exceptions-in-supervised-coroutines'></a>[Exceptions in supervised coroutines](docs/exception-handling.md#exceptions-in-supervised-coroutines)
Roman Elizarov715acd32018-10-08 20:20:12 +0300109<!--- TOC_REF docs/shared-mutable-state-and-concurrency.md -->
110* <a name='shared-mutable-state-and-concurrency'></a>[Shared mutable state and concurrency](docs/shared-mutable-state-and-concurrency.md#shared-mutable-state-and-concurrency)
111 * <a name='the-problem'></a>[The problem](docs/shared-mutable-state-and-concurrency.md#the-problem)
112 * <a name='volatiles-are-of-no-help'></a>[Volatiles are of no help](docs/shared-mutable-state-and-concurrency.md#volatiles-are-of-no-help)
113 * <a name='thread-safe-data-structures'></a>[Thread-safe data structures](docs/shared-mutable-state-and-concurrency.md#thread-safe-data-structures)
114 * <a name='thread-confinement-fine-grained'></a>[Thread confinement fine-grained](docs/shared-mutable-state-and-concurrency.md#thread-confinement-fine-grained)
115 * <a name='thread-confinement-coarse-grained'></a>[Thread confinement coarse-grained](docs/shared-mutable-state-and-concurrency.md#thread-confinement-coarse-grained)
116 * <a name='mutual-exclusion'></a>[Mutual exclusion](docs/shared-mutable-state-and-concurrency.md#mutual-exclusion)
117 * <a name='actors'></a>[Actors](docs/shared-mutable-state-and-concurrency.md#actors)
118<!--- TOC_REF docs/select-expression.md -->
Roman Elizarov3258e1f2019-08-22 20:08:48 +0300119* <a name='select-expression-experimental'></a>[Select Expression (experimental)](docs/select-expression.md#select-expression-experimental)
Roman Elizarov715acd32018-10-08 20:20:12 +0300120 * <a name='selecting-from-channels'></a>[Selecting from channels](docs/select-expression.md#selecting-from-channels)
121 * <a name='selecting-on-close'></a>[Selecting on close](docs/select-expression.md#selecting-on-close)
122 * <a name='selecting-to-send'></a>[Selecting to send](docs/select-expression.md#selecting-to-send)
123 * <a name='selecting-deferred-values'></a>[Selecting deferred values](docs/select-expression.md#selecting-deferred-values)
124 * <a name='switch-over-a-channel-of-deferred-values'></a>[Switch over a channel of deferred values](docs/select-expression.md#switch-over-a-channel-of-deferred-values)
125<!--- END -->