std::packaged_task

From Cppreference

C++ Standard Library
Language Utilities library Strings library Containers library Algorithms library Iterators library Numerics library Input/output library Localizations library Regular expressions library (C++11) Atomic operations library (C++11) Thread support library (C++11)
Thread support library
Threads thread (C++11) this_thread namespace get_id (C++11) yield (C++11) sleep_for (C++11) sleep_until (C++11) Mutual exclusion mutex (C++11) timed_mutex (C++11) recursive_mutex (C++11) recursive_timed_mutex (C++11) Generic lock management lock_guard (C++11) unique_lock (C++11) defer_lock_t try_to_lock_t adopt_lock_t (C++11) (C++11) (C++11) lock (C++11) try_lock (C++11) defer_lock try_to_lock adopt_lock (C++11) (C++11) (C++11) Condition variables condition_variable (C++11) condition_variable_any (C++11) notify_all_at_thread_exit (C++11) cv_status (C++11) Futures promise (C++11) packaged_task (C++11) future (C++11) shared_future (C++11) async (C++11)
std::packaged_task
Member functions packaged_task::packaged_task packaged_task::~packaged_task packaged_task::operator= packaged_task::valid packaged_task::swap Getting the result packaged_task::get_future Execution packaged_task::operator() packaged_task::make_ready_at_thread_exit packaged_task::reset

Defined in header <future>
template< class > class packaged_task; //not defined	(1)	(since C++11)
template< class Function, class Args... > class packaged_task<Function(Args...)>;	(2)	(since C++11)

The class template std::packaged_task packages a function to store its return value that is later acquired asynchronously via a std::future object, that the std::packaged_task can supply.

This section is incomplete

Contents 1 Member functions 1.1 Getting the result 1.2 Execution 2 Non-member functions 3 Helper classes

[edit] Member functions

(constructor)	constructs the task object (public member function)
(destructor)	destructs the task object (public member function)
operator=	moves the task object (public member function)
valid	checks if the task object has a valid function (public member function)
swap	swaps two task objects (public member function)
Getting the result
get_future	returns a future associated with the promised result (public member function)
Execution
operator()	executes the function (public member function)
make_ready_at_thread_exit	executes the function ensuring that the result is ready only once the current thread exits (public member function)
reset	resets the state abandoning any stored results of previous executions (public member function)

[edit] Non-member functions

This section is incomplete

[edit] Helper classes

std::uses_allocator<std::packaged_task> (C++11)	specializes the std::uses_allocator type trait (class template specialization)