std::atomic_flag_clear, std::atomic_flag_clear_explicit

From cppreference.com
< cpp‎ | atomic
 
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Free functions for atomic operations
Free functions for atomic flags
atomic_flag_clearatomic_flag_clear_explicit
(C++11)(C++11)
Memory ordering
Mutual exclusion
(C++11)
Generic lock management
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Semaphores
Latches and barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
 
Defined in header <atomic>
(1) (since C++11)
void atomic_flag_clear( volatile std::atomic_flag* p ) noexcept;
void atomic_flag_clear( std::atomic_flag* p ) noexcept;
(2) (since C++11)
void atomic_flag_clear_explicit( volatile std::atomic_flag* p,
                                 std::memory_order order ) noexcept;
void atomic_flag_clear_explicit( std::atomic_flag* p,
                                 std::memory_order order ) noexcept;

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

Parameters

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

Return value

(none)

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);
}

See also

the lock-free boolean atomic type
(class)
atomically sets the flag to true and returns its previous value
(function)
defines memory ordering constraints for the given atomic operation
(enum)