File: future

package info (click to toggle)
cppreference-doc 20170409-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 259,872 kB
  • sloc: xml: 570,184; python: 1,923; php: 520; makefile: 168; sh: 25; cpp: 9; ansic: 9
file content (187 lines) | stat: -rw-r--r-- 5,248 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
/*  Copyright (C) 2015  Povilas Kanapickas <povilas@radix.lt>

    This file is part of cppreference-doc

    This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
    Unported License. To view a copy of this license, visit
    http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
    Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.3 or
    any later version published by the Free Software Foundation; with no
    Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
*/

#ifndef CPPREFERENCE_FUTURE_H
#define CPPREFERENCE_FUTURE_H

#if CPPREFERENCE_STDVER>= 2011
#include <stdexcept>

namespace std {

template<class R>
class promise { // SIMPLIFIED: removed R& and void specializations
public:
    promise();
    template<class Alloc>
    promise(std::allocator_arg_t, const Alloc& alloc);
    promise(promise&& other);
    promise(const promise& other) = delete;

    ~promise();

    promise& operator=(promise&& other);
    promise& operator=(const promise& rhs) = delete;

    void swap(promise& other);

    std::future<T> get_future();

    void set_value(const R& value);
    void set_value(R&& value);
    void set_value(R& value);   // member of R& specialization
    void set_value(); // member of void specialization
    void set_value_at_thread_exit(const R& value);
    void set_value_at_thread_exit(R&& value);
    void set_value_at_thread_exit(R& value);   // member of R& specialization
    void set_value_at_thread_exit(); // member of void specialization
    void set_exception(std::exception_ptr p);
    void set_exception_at_thread_exit(std::exception_ptr p);
};

template<class R>
void swap(promise<R>& lhs, promise<R>& rhs);

template<class R, class ...Args>
class packaged_task<R(Args...)> {
public:
    packaged_task();

    template <class F>
    explicit packaged_task(F&& f);

    template <class F, class Allocator>
    explicit packaged_task(std::allocator_arg_t, const Allocator& a, F&& f);

    packaged_task(const packaged_task&) = delete;
    packaged_task(packaged_task&& rhs);

    ~packaged_task();

    packaged_task& operator=(const packaged_task&) = delete;
    packaged_task& operator=(packaged_task&& rhs);

    bool valid() const;

    void swap(packaged_task& other);

    std::future<R> get_future();

    void operator()(ArgTypes... args);

    void make_ready_at_thread_exit(ArgTypes... args);

    void reset();
};

template<class Function, class... Args>
void swap(packaged_task<Function(Args...)>& lhs,
          packaged_task<Function(Args...)>& rhs);

template<class T>
class future { // SIMPLIFIED: removed T& and void specializations
public:
    future();
    future(future&& other);
    future(const future& other) = delete;
    ~future();

    future& operator=(future&& other);
    future& operator=(const future& other) = delete;

    std::shared_future<T> share();

    T get(); // member only of generic specialization
    T& get(); // member only of T& specialization
    void get(); // member only of void specialization

    bool valid() const;

    void wait() const;

    template<class Rep, class Period>
    std::future_status wait_for(const std::chrono::duration<Rep, Period>& timeout_duration) const;

    template<class Clock, class Duration>
    std::future_status wait_until(const std::chrono::time_point<Clock, Duration>& timeout_time) const;
};

template<class T>
class shared_future { // SIMPLIFIED: removed T& and void specializations
public:
    shared_future();
    shared_future(const shared_future& other);
    shared_future(std::future<T>&& other);
    shared_future(shared_future&& other);

    ~shared_future();

    shared_future& operator=(const shared_future& other);
    shared_future& operator=(shared_future&& other);

    T get(); // member only of generic specialization
    T& get(); // member only of T& specialization
    void get(); // member only of void specialization

    bool valid() const;

    void wait() const;

    template<class Rep, class Period>
    std::future_status wait_for(const std::chrono::duration<Rep, Period>& timeout_duration) const;

    template<class Clock, class Duration>
    std::future_status wait_until(const std::chrono::time_point<Clock, Duration>& timeout_time) const;
};

enum class launch {
    async,
    deferred
};

enum class future_status {
    ready,
    timeout,
    deferred
};

enum class future_errc {
    broken_promise,
    future_already_retrieved,
    promise_already_satisfied,
    no_state
};

class future_error : public logic_error {
public:
    future_error(std::error_code ec);
    const std::error_code& code() const;
};

template<class Function, class... Args>
std::future<typename std::result_of<Function(Args...)>::type>
async(Function&& f, Args&& ... args);

template<class Function, class... Args>
std::future<typename std::result_of<Function(Args...)>::type>
async(std::launch policy, Function&& f, Args&& ... args);

const std::error_category& future_category();

} // namespace std

#endif // CPPREFERENCE_STDVER>= 2011

#endif // CPPREFERENCE_FUTURE_H