jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add note on channel usage with spawn (#10627) [ci skip]

Browse source
This commit is contained in:
Federico Ceratto 2019-02-10 19:52:13 +00:00 • committed by Andreas Rumpf
commit 8f05b34125
1 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

11
lib/system/channels.nim
View file

@ -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`.