Namespaces
Variants

Standard library header <future> (C++11)

From cppreference.net
Standard library headers

Этот заголовок является частью библиотеки поддержки потоков .

Содержание

Классы

(C++11)
хранит значение для асинхронного получения
(шаблон класса)
упаковывает функцию для хранения её возвращаемого значения для асинхронного получения
(шаблон класса)
(C++11)
ожидает значение, которое устанавливается асинхронно
(шаблон класса)
ожидает значение (возможно используемое другими future), которое устанавливается асинхронно
(шаблон класса)
(C++11)
определяет политику запуска для std::async
(перечисление)
определяет результаты ожидания с таймаутом для std::future и std::shared_future
(перечисление)
сообщает об ошибке, связанной с future или promise
(класс)
идентифицирует коды ошибок future
(enum)
специализирует std::uses_allocator type trait
(специализация шаблона класса)
специализирует std::uses_allocator type trait
(специализация шаблона класса)

Функции

(C++11)
запускает функцию асинхронно (потенциально в новом потоке) и возвращает std::future , который будет содержать результат
(шаблон функции)
идентифицирует категорию ошибок future
(функция)
специализирует алгоритм std::swap
(шаблон функции)
специализирует алгоритм std::swap
(шаблон функции)

Синопсис

namespace std {
  enum class future_errc {
    broken_promise = /* implementation-defined */,
    future_already_retrieved = /* implementation-defined */,
    promise_already_satisfied = /* implementation-defined */,
    no_state = /* implementation-defined */
  };
  enum class launch : /* unspecified */ {
    async = /* unspecified */,
    deferred = /* unspecified */,
    /* implementation-defined */
  };
  enum class future_status {
    ready,
    timeout,
    deferred
  };
  template<> struct is_error_code_enum<future_errc> : public true_type { };
  error_code make_error_code(future_errc e) noexcept;
  error_condition make_error_condition(future_errc e) noexcept;
  const error_category& future_category() noexcept;
  class future_error;
  template<class R> class promise;
  template<class R> class promise<R&>;
  template<> class promise<void>;
  template<class R>
    void swap(promise<R>& x, promise<R>& y) noexcept;
  template<class R, class Alloc>
    struct uses_allocator<promise<R>, Alloc>;
  template<class R> class future;
  template<class R> class future<R&>;
  template<> class future<void>;
  template<class R> class shared_future;
  template<class R> class shared_future<R&>;
  template<> class shared_future<void>;
  template<class> class packaged_task;  // не определен
  template<class R, class... ArgTypes>
    class packaged_task<R(ArgTypes...)>;
  template<class R, class... ArgTypes>
    void swap(packaged_task<R(ArgTypes...)>&, packaged_task<R(ArgTypes...)>&) noexcept;
  template<class F, class... Args>
    future<invoke_result_t<decay_t<F>, decay_t<Args>...>>
      async(F&& f, Args&&... args);
  template<class F, class... Args>
    future<invoke_result_t<decay_t<F>, decay_t<Args>...>>
      async(launch policy, F&& f, Args&&... args);
}

Класс std::future_error

namespace std {
  class future_error : public logic_error {
  public:
    explicit future_error(future_errc e);
    const error_code& code() const noexcept;
    const char*       what() const noexcept;
  private:
    error_code ec_;             // только для демонстрации
  };
}

Шаблон класса std::promise

namespace std {
  template<class R>
  class promise {
  public:
    promise();
    template<class Allocator>
      promise(allocator_arg_t, const Allocator& a);
    promise(promise&& rhs) noexcept;
    promise(const promise&) = delete;
    ~promise();
    // присваивание
    promise& operator=(promise&& rhs) noexcept;
    promise& operator=(const promise&) = delete;
    void swap(promise& other) noexcept;
    // получение результата
    future<R> get_future();
    // установка результата
    void set_value(/* см. описание */);
    void set_exception(exception_ptr p);
    // установка результата с отложенным уведомлением
    void set_value_at_thread_exit(/* см. описание */);
    void set_exception_at_thread_exit(exception_ptr p);
  };
  template<class R>
    void swap(promise<R>& x, promise<R>& y) noexcept;
  template<class R, class Alloc>
    struct uses_allocator<promise<R>, Alloc>;
}

Шаблон класса std::future

namespace std {
  template<class R>
  class future {
  public:
    future() noexcept;
    future(future&&) noexcept;
    future(const future&) = delete;
    ~future();
    future& operator=(const future&) = delete;
    future& operator=(future&&) noexcept;
    shared_future<R> share() noexcept;
    // получение значения
    /* см. описание */ get();
    // функции проверки состояния
    bool valid() const noexcept;
    void wait() const;
    template<class Rep, class Period>
      future_status wait_for(const chrono::duration<Rep, Period>& rel_time) const;
    template<class Clock, class Duration>
      future_status wait_until(const chrono::time_point<Clock, Duration>& abs_time) const;
  };
}

Шаблон класса std::shared_future

namespace std {
  template<class R>
  class shared_future {
  public:
    shared_future() noexcept;
    shared_future(const shared_future& rhs) noexcept;
    shared_future(future<R>&&) noexcept;
    shared_future(shared_future&& rhs) noexcept;
    ~shared_future();
    shared_future& operator=(const shared_future& rhs) noexcept;
    shared_future& operator=(shared_future&& rhs) noexcept;
    // получение значения
    /* см. описание */ get() const;
    // функции проверки состояния
    bool valid() const noexcept;
    void wait() const;
    template<class Rep, class Period>
      future_status wait_for(const chrono::duration<Rep, Period>& rel_time) const;
    template<class Clock, class Duration>
      future_status wait_until(const chrono::time_point<Clock, Duration>& abs_time) const;
  };
}

Шаблон класса std::packaged_task

namespace std {
  template<class> class packaged_task;  // не определен
  template<class R, class... ArgTypes>
  class packaged_task<R(ArgTypes...)> {
  public:
    // конструкция и деструкция
    packaged_task() noexcept;
    template<class F>
      explicit packaged_task(F&& f);
    ~packaged_task();
    // копирование запрещено
    packaged_task(const packaged_task&) = delete;
    packaged_task& operator=(const packaged_task&) = delete;
    // поддержка перемещения
    packaged_task(packaged_task&& rhs) noexcept;
    packaged_task& operator=(packaged_task&& rhs) noexcept;
    void swap(packaged_task& other) noexcept;
    bool valid() const noexcept;
    // получение результата
    future<R> get_future();
    // выполнение
    void operator()(ArgTypes... );
    void make_ready_at_thread_exit(ArgTypes...);
    void reset();
  };
  template<class R, class... ArgTypes>
  packaged_task(R (*)(ArgTypes...)) -> packaged_task<R(ArgTypes...)>;
  template<class F> packaged_task(F) -> packaged_task</* см. описание */>;
  template<class R, class... ArgTypes>
    void swap(packaged_task<R(ArgTypes...)>& x, packaged_task<R(ArgTypes...)>& y) noexcept;
}