Baza znanjaCentar za ispite
HRHrvatski
Odaberi jezik13

CKTIS / C++

std::coroutine_handle: nevlasnički pristup okviru korutine

std::coroutine_handle je kopirljiva referenca nalik pokazivaču na okvir korutine i sama ne upravlja njegovim životnim vijekom.

Verzija: C++23

Sintaksa

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> iz <coroutine> upućuje na okvir suspendirane korutine i može izložiti njezin promise(). Zadano konstruiran ili poništen handle je prazan; pretvorba u bool samo provjerava spremljenu adresu. Kopije upućuju na isti okvir bez zajedničkog vlasništva.

Predložak std::coroutine_handle ne posjeduje okvir. Za tipizirani handle std::coroutine_handle::from_promise zahtijeva referencu na promise objekt korutine i dobiva handle te korutine, dok std::coroutine_handle::promise vraća referencu na njezin promise. std::coroutine_handle::done zahtijeva suspendiranu korutinu i provjerava završnu suspenziju; std::coroutine_handle::resume zahtijeva suspenziju koja nije završna, a std::coroutine_handle::destroy zahtijeva valjano suspendiranu korutinu i uništava okvir.

resume() se smije pozvati samo za korutinu suspendiranu prije završne točke suspenzije. done() zahtijeva valjan suspendiran okvir i javlja je li završna suspenzija dosegnuta. Poziv preko praznog, visećeg ili neispravno suspendiranog handle uzrokuje nedefinirano ponašanje.

destroy() uništava suspendirani okvir i oslobađa memoriju; ako se okvir ne uništi sam, to se mora dogoditi točno jednom. Sve kopije zatim vise. Primjer koristi suspend_always na početku i kraju te samo premjestivog vlasnika RAII čiji destruktor poziva destroy().

Primjeri

#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';
}

Rezultat

0
body
1

std::coroutine_handle → 0 body 1

Izvori