std::packaged_task::packaged_task

 

C++

Language

Standard library headers

Concepts

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) shared_lock (C++14) 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) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (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

 

packaged_task()	(1)
template <class F> explicit packaged_task(F&& f)	(2)
template <class F, class Allocator> explicit packaged_task(std::allocator_arg_t, const Allocator& a, F&& f)	(3)
packaged_task(const packaged_task&) = delete	(4)
packaged_task(packaged_task&& rhs)	(5)

1) Constructs a std::packaged_task object with no task and no shared state.

2) Constructs a std::packaged_task object with a shared state and a copy of the task, initialized with std::forward<F>(f).

3) Constructs a std::packaged_task object with a shared state and a copy of the task, initialized with std::forward<F>(f). Uses the provided allocator to allocate memory necessary to store the task.

4) The copy constructor is deleted, std::packaged_task is move-only. Note: C++11 does not specify const here, this is the defect 2067.

5) Constructs a std::packaged_task with the shared state and task formerly owned by rhs, leaving rhs with no shared state and a moved-from task.

Parameters

f	-	the callable target (function, member function, lambda-expression, functor) to execute
a	-	the allocator to use when storing the task
rhs	-	the std::packaged_task to move from

Exceptions

1)

noexcept specification:  

noexcept

  (since C++11)

2-3) Any exceptions thrown by copy/move constructor of f and possiblly std::bad_alloc if the allocation fails.

5)

noexcept specification:  

noexcept

  (since C++11)

Example

run this code

#include <future>
#include <iostream>
#include <thread>
 
int fib(int n)
{
    if (n < 3) return 1;
    else return fib(n-1) + fib(n-2);
}
 
int main()
{
    std::packaged_task<int(int)> fib_task(&fib); 
 
    std::cout << "starting task\n";
    auto result = fib_task.get_future();
    std::thread t(std::move(fib_task), 40);
 
    std::cout << "waiting for task to finish...\n";
    std::cout << result.get() << '\n';
 
    std::cout << "task complete\n";                                                                                                                                                                           
    t.join();
}

Output:

starting task
waiting for task to finish...
102334155
task complete