Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-25 04:55:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Revised index to add section headers

Browse source
This commit is contained in:
Justin Ethier 2019-06-19 10:19:30 -04:00
parent d6082e1f09
commit 0c13615ae6
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/api/cyclone/concurrent.md
View file

@ -1,14 +1,20 @@
# Concurrency Library # Concurrency Library
The `(cyclone concurrent)` library provides functions to make it easier to write concurrent programs. The `(cyclone concurrent)` library makes it easier to write concurrent programs using Cyclone.
This library complements the functionality provided by [SRFI 18](../srfi/18.md). This library complements the functionality provided by [SRFI 18](../srfi/18.md).
## Index ## Index
### [Shared Objects](#shared-objects)
- [`make-shared`](#make-shared) - [`make-shared`](#make-shared)
- [`share-all!`](#share-all) - [`share-all!`](#share-all)
### [Immutability](#immutability)
- [`immutable?`](#immutable) - [`immutable?`](#immutable)
### [Atoms](#atoms)
- [`make-atom`](#make-atom) - [`make-atom`](#make-atom)
- [`atom`](#atom) - [`atom`](#atom)
- [`atom?`](#atom-1) - [`atom?`](#atom-1)
@ -50,7 +56,7 @@ Allow all objects currently on the calling thread's local stack to be shared wit
Note this function will trigger a minor garbage collection on the calling thread. Note this function will trigger a minor garbage collection on the calling thread.
## Immutable objects ## Immutability
Many types of objects are mutable by default: pairs, strings, vectors, and bytevectors. However, if an object is declared as a literal constant then it will be designated immutable. Many types of objects are mutable by default: pairs, strings, vectors, and bytevectors. However, if an object is declared as a literal constant then it will be designated immutable.