Namespaces
Variants
Views
Actions

std::call_once

From cppreference.com
< cpp‎ | thread
Revision as of 18:32, 9 July 2013 by P12bot (Talk | contribs)

Defined in header <mutex>
template< class Function, class... Args >
void call_once( std::once_flag& flag, Function&& f, Args&& args... );
(since C++11)

Executes the function f exactly once, even if called from several threads.

Each group of call_once invocations that receives the same std::once_flag object will meet the following requirements:

  • Exactly one execution of exactly one of the functions (passed as f to the invocations in the group) is performed. It is undefined which function will be selected for execution. The selected function runs in the same thread as the call_once invocation it was passed to.
  • No invocation in the group returns before the abovementioned execution of the selected function is completed successfully, that is, doesn't exit via an exception.
  • If the selected function exits via exception, it is propagated to the caller. Another function is then selected and executed.

Contents

Parameters

flag - an object, for which exactly one function gets executed
f - function to call
args... - arguments to pass to the function

Return value

(none)

Exceptions

  • std::system_error if any condition prevents calls to call_once from executing as specified
  • any exception thrown by f

Example

#include <iostream>
#include <thread>
#include <mutex>
 
std::once_flag flag;
 
void do_once()
{
    std::call_once(flag, [](){ std::cout << "Called once" << std::endl; });
}
 
int main()
{
    std::thread t1(do_once);
    std::thread t2(do_once);
    std::thread t3(do_once);
    std::thread t4(do_once);
 
    t1.join();
    t2.join();
    t3.join();
    t4.join();
}

Output:

Called once

See also

(C++11)
helper object to ensure that call_once invokes the function only once
(class) [edit]