Namespaces
Variants
Views
Actions

std::atomic_is_lock_free, ATOMIC_xxx_LOCK_FREE

From cppreference.com
< cpp‎ | atomic
Revision as of 17:10, 2 November 2012 by P12bot (Talk | contribs)

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <atomic>
</td>

<td></td> <td></td> <tr class="t-dcl-sep"><td></td><td></td><td></td></tr>

<tr class="t-dcl ">

<td >
template< class Atomic >
bool atomic_is_lock_free(const volatile Atomic* obj)
</td>

<td > (1) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl-sep"><td></td><td></td><td></td></tr>

<tr class="t-dcl ">

<td >
template< class Atomic >
bool atomic_is_lock_free(const Atomic* obj)
</td>

<td > (2) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl-sep"><td></td><td></td><td></td></tr>

<tr class="t-dcl ">

<td >
#define ATOMIC_CHAR_LOCK_FREE     /* unspecified */

#define ATOMIC_CHAR16_T_LOCK_FREE /* unspecified */
#define ATOMIC_CHAR32_T_LOCK_FREE /* unspecified */
#define ATOMIC_WCHAR_T_LOCK_FREE  /* unspecified */
#define ATOMIC_SHORT_LOCK_FREE    /* unspecified */
#define ATOMIC_INT_LOCK_FREE      /* unspecified */
#define ATOMIC_LONG_LOCK_FREE     /* unspecified */
#define ATOMIC_LLONG_LOCK_FREE    /* unspecified */

#define ATOMIC_POINTER_LOCK_FREE  /* unspecified */
</td>

<td > (3) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

1-2) Determines if the atomic object pointed to by obj is implemented lock-free, as if by calling obj->is_lock_free()

3) Expands to an integer constant expression with value 0 for the built-in atomic types that are never lock-free, to 1 for the built-in atomic types that are sometimes lock-free, and to 2 for the built-in atomic types that are always lock-free.

Contents

Notes

All atomic types except for std::atomic_flag may be implemented using mutexes or other locking operations, rather than using the lock-free atomic CPU instructions. Atomic types are also allowed to be sometimes lock-free, e.g. if only aligned memory accesses are naturally atomic on a given architecture, misaligned objects of the same type have to use locks. If the type is sometimes lock-free, then the function (1-2) or its member function equivalent has to be used to determine if the particular instance is lock-free.

Parameters

obj - pointer to the atomic object to examine

Return value

true if *obj is a lock-free atomic, false otherwise.

Exceptions

noexcept specification:  
noexcept
  

Example

See also

Template:cpp/atomic/atomic/dcl list is lock freeTemplate:cpp/atomic/dcl list atomic flag
specializes atomic operations for std::shared_ptr
(function template)