Namespaces
Variants
Views
Actions

std::packaged_task

From cppreference.com
< cpp‎ | thread
Revision as of 06:01, 25 June 2012 by P12 (Talk | contribs)

 
 
Concurrency support library
Threads
(C++11)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
(C++11)
Generic lock management
(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)
packaged_task
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
Hazard Pointers
Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
Free functions for atomic operations
Free functions for atomic flags
 
 

Template:ddcl list begin <tr class="t-dsc-header">

<td>
Defined in header <future>
</td>

<td></td> <td></td> </tr> <tr class="t-dcl ">

<td >
template< class > class packaged_task; //not defined
</td>

<td > (1) </td> <td > (since C++11) </td> </tr> <tr class="t-dcl ">

<td >
template< class Function, class Args... >
class packaged_task<R(Args...)>;
</td>

<td > (2) </td> <td > (since C++11) </td> </tr> Template:ddcl list end

The class template std::packaged_task wraps any callable target (function, lambda expression, bind expression, or another function object) so that it can be invoked asynchronously, and its return value or exception thrown is stored in the shared state, which can be accessed through std::future objects.

Just like std::function, std::packaged_task is a polymorphic, allocator-aware container: the stored callable target may be allocated on heap or with a provided allocator.

Contents

Member functions

Template:cpp/thread/packaged task/dcl list constructorTemplate:cpp/thread/packaged task/dcl list destructorTemplate:cpp/thread/packaged task/dcl list operator=Template:cpp/thread/packaged task/dcl list validTemplate:cpp/thread/packaged task/dcl list swapTemplate:cpp/thread/packaged task/dcl list get futureTemplate:cpp/thread/packaged task/dcl list operator()Template:cpp/thread/packaged task/dcl list make ready at thread exitTemplate:cpp/thread/packaged task/dcl list reset
Getting the result
Execution

Non-member functions

Template:cpp/thread/packaged task/dcl list swap2

Helper classes

Template:cpp/thread/packaged task/dcl list uses allocator

Example

#include <iostream>
#include <future>
#include <thread>
 
int main()
{
    std::packaged_task<int()> task([](){return 7;}); // wrap the function
    std::future<int> result = task.get_future();  // get a future
    std::thread(std::move(task)).detach(); // launch on a thread
    std::cout << "Waiting...";
    result.wait();
    std::cout << "Done!\nResult is " << result.get() << '\n';
}

Output:

Waiting...Done!
Result is 7

See also

Template:cpp/thread/dcl list future