diff options
| author | Federico Ceratto <federico.ceratto@gmail.com> | 2019-02-10 19:52:13 +0000 |
|---|---|---|
| committer | Andreas Rumpf <rumpf_a@web.de> | 2019-02-13 23:30:14 +0100 |
| commit | 8f05b3412568ec66a72bcae221613630d561aac0 (patch) | |
| tree | be6bf1f70cdd4cdc20600992073881a83a7c3f9a /lib/system/channels.nim | |
| parent | 02b5fc940dc2957cee9227af1b058268baed8208 (diff) | |
| download | Nim-8f05b3412568ec66a72bcae221613630d561aac0.tar.gz | |
Add note on channel usage with spawn (#10627) [ci skip]
Diffstat (limited to 'lib/system/channels.nim')
| -rw-r--r-- | lib/system/channels.nim | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/lib/system/channels.nim b/lib/system/channels.nim index 14d3a3005..057ea2843 100644 --- a/lib/system/channels.nim +++ b/lib/system/channels.nim @@ -7,12 +7,17 @@ # distribution, for details about the copyright. # -## Channel support for threads. **Note**: This is part of the system module. -## Do not import it directly. To activate thread support you need to compile -## with the ``--threads:on`` command line switch. +## Channel support for threads. +## +## **Note**: This is part of the system module. Do not import it directly. +## To activate thread support compile with the ``--threads:on`` command line switch. +## +## **Note:** Channels are designed for the ``Thread`` type. They are unstable when +## used with ``spawn`` ## ## **Note:** The current implementation of message passing does ## not work with cyclic data structures. +## ## **Note:** Channels cannot be passed between threads. Use globals or pass ## them by `ptr`. |