Namespaces
Variants
Views
Actions

std::atomic_flag_clear, std::atomic_flag_clear_explicit

From cppreference.com
< cpp‎ | atomic
Revision as of 11:50, 23 September 2013 by P12 (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Defined in header <atomic>
(1) (since C++11)
void atomic_flag_clear( volatile std::atomic_flag* p );
void atomic_flag_clear( std::atomic_flag* p );
(2) (since C++11)
void atomic_flag_clear_explicit( volatile std::atomic_flag* p,
                                 std::memory_order order )
void atomic_flag_clear_explicit( std::atomic_flag* p,
                                 std::memory_order order )

Atomically changes the state of a std::atomic_flag pointed to by p to clear (false).

Contents

[edit] Parameters

p - pointer to std::atomic_flag to access
order - the memory sycnhronization ordering for this operation: only std::memory_order_relaxed, std::memory_order_acquire, or std::memory_order_seq_cst are permitted.

[edit] Return value

none.

[edit] Exceptions

noexcept specification:  
noexcept
  

[edit] Possible implementation

First version
void atomic_flag_clear(volatile std::atomic_flag* p) 
{
    p->clear();
}
Second version
void atomic_flag_clear(std::atomic_flag* p) 
{
    p->clear();
}
Third version
void atomic_flag_clear_explicit(volatile std::atomic_flag* p, 
                                std::memory_order order) 
{
    p->clear(order);
}
Fourth version
void atomic_flag_clear_explicit(std::atomic_flag* p, 
                                std::memory_order order) 
{
    p->clear(order);
}

[edit] See also

the lock-free boolean atomic type
(class) [edit]
atomically sets the flag to true and returns its previous value
(function) [edit]
defines memory ordering constraints for the given atomic operation
(typedef) [edit]
C documentation for atomic_flag_clear, atomic_flag_clear_explicit