From fb2b9d9afa8edd073734f196d8c50bbdf09f05b3 Mon Sep 17 00:00:00 2001 From: Ashlynn <37787862+Ashthetik@users.noreply.github.com> Date: Fri, 18 Oct 2024 01:07:20 +1100 Subject: [PATCH] doc: Extend Coroutine Documentation (#1288) --- docpages/example_programs/using_coroutines/coro_introduction.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docpages/example_programs/using_coroutines/coro_introduction.md b/docpages/example_programs/using_coroutines/coro_introduction.md index e91a4a271e..0e51c1b3cb 100644 --- a/docpages/example_programs/using_coroutines/coro_introduction.md +++ b/docpages/example_programs/using_coroutines/coro_introduction.md @@ -18,3 +18,5 @@ When using a `co_*` function such as `co_message_create`, the request is sent im You may hear that coroutines are "writing async code as if it was sync", while this is sort of correct, it may limit your understanding and especially the dangers of coroutines. I find **they are best thought of as a shortcut for a state machine**, if you've ever written one, you know what this means. Think of the lambda as *its constructor*, in which captures are variable parameters. Think of the parameters passed to your lambda as data members in your state machine. When you `co_await` something, the state machine's function exits, the program goes back to the caller, at this point the calling function may return. References are kept as references in the state machine, which means by the time the state machine is resumed, the reference may be dangling: \ref lambdas-and-locals "this is not good"! Another way to think of them is just like callbacks but keeping the current scope intact. In fact this is exactly what it is, the co_* functions call the normal API calls, with a callback that resumes the coroutine, *in the callback thread*. This means you cannot rely on thread_local variables and need to keep in mind concurrency issues with global states, as your coroutine will be resumed in another thread than the one it started on. + +It is also worth noting that coroutines can lead to cases where errors may fall through and remain uncaptured, requiring the user to manually handle the error. These exceptions occur because callbacks cannot be used in their typical manner, which can be observed [in the following issue](https://github.com/brainboxdotcc/DPP/issues/1222) and the \ref coro-simple-commands "sample coroutine code".