База знанияИзпитен център
BGБългарски
Избери език13

CKTIS / C++

std::coroutine_handle: непритежаващ достъп до рамка на корутина

std::coroutine_handle е копируема подобна на указател референция към рамка на корутина и сам не управлява живота ѝ.

Версия: C++23

Синтаксис

template<class Promise = void>
struct coroutine_handle {
    static coroutine_handle from_promise(Promise&);
    constexpr explicit operator bool() const noexcept;
    bool done() const;
    void resume() const;
    void destroy() const;
    Promise& promise() const;
};

std::coroutine_handle<Promise> от <coroutine> сочи рамката на спряна корутина и може да даде нейния promise(). Създаден по подразбиране или нулиран handle е празен; преобразуването към bool само проверява съхранен адрес. Копията сочат същата рамка без споделена собственост.

Шаблонът std::coroutine_handle не притежава рамката. За типизиран handle std::coroutine_handle::from_promise изисква референция към promise обекта на корутина и получава handle към нея, а std::coroutine_handle::promise връща референция към нейния promise. std::coroutine_handle::done изисква спряна корутина и проверява крайното спиране; std::coroutine_handle::resume изисква спиране, което не е крайно, а std::coroutine_handle::destroy изисква валидно спряна корутина и унищожава рамката.

resume() може да се извика само за корутина, спряна преди крайната точка на спиране. done() изисква валидна спряна рамка и съобщава дали е достигнато крайното спиране. Извикване през празен, висящ или неправилно спрян handle води до неопределено поведение.

destroy() унищожава спряна рамка и освобождава паметта ѝ; ако рамката не се самоунищожава, това трябва да стане точно веднъж. После всички копия висят. Примерът използва suspend_always в началото и края и само преместваем RAII собственик, чийто деструктор извиква destroy().

Примери

#include <coroutine>
#include <exception>
#include <iostream>
#include <utility>

struct Task {
    struct promise_type;
    using Handle = std::coroutine_handle<promise_type>;

    struct promise_type {
        Task get_return_object() { return Task{Handle::from_promise(*this)}; }
        std::suspend_always initial_suspend() noexcept { return {}; }
        std::suspend_always final_suspend() noexcept { return {}; }
        void return_void() noexcept {}
        void unhandled_exception() { std::terminate(); }
    };

    Handle handle;
    explicit Task(Handle value) : handle(value) {}
    Task(const Task&) = delete;
    Task(Task&& other) noexcept : handle(std::exchange(other.handle, {})) {}
    ~Task() { if (handle) handle.destroy(); }
};

Task make_task() {
    std::cout << "body\n";
    co_return;
}

int main() {
    Task task = make_task();
    std::cout << task.handle.done() << '\n';
    task.handle.resume();
    std::cout << task.handle.done() << '\n';
}

Резултат

0
body
1

std::coroutine_handle → 0 body 1

Източници