2
0
mirror of https://github.com/boostorg/atomic.git synced 2026-01-27 18:52:09 +00:00

atomic: update documentation

[SVN r81737]
This commit is contained in:
Tim Blechmann
2012-12-06 12:35:42 +00:00
parent 3c288331b0
commit be1524ea4e

View File

@@ -9,6 +9,7 @@
[quickbook 1.4]
[authors [Bahmann, Helge]]
[copyright 2011 Helge Bahmann]
[copyright 2012 Tim Blechmann]
[id atomic]
[dirname atomic]
[purpose Atomic operations]
@@ -414,6 +415,10 @@ All atomic objects supports the following operations:
[`atomic(T initial_value)`]
[Initialize to [^initial_value]]
]
[
[`bool is_lock_free()`]
[Checks if the atomic object is lock-free]
]
[
[`T load(memory_order order)`]
[Return current value]
@@ -645,6 +650,8 @@ limitations that cannot be lifted without compiler support:
as "full compiler barriers" in this implementation. In corner
cases this may lead to worse code than a C++11 compiler
could generate.
* [*No interprocess fallback]: using `atomic<T>` in shared memory only works
correctly, if `atomic<T>::is_lock_free == true`
[endsect]