Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / C++

co_await — čakanie v coroutine

Výraz co_await používa protokol awaitera na prípadné pozastavenie coroutine a následné získanie výsledku. Sám nespúšťa vlákno ani neposkytuje plánovanie; obnovenie musí zabezpečiť použitá implementácia.

Verzia: C++23; repository compiler flag, production runtime not attested

Syntax

co_await cast-expression

co_await expression označuje možné miesto pozastavenia coroutine, nie blokujúce čakanie vlákna. Vložením takéhoto výrazu do tela funkcie sa z nej stane coroutine. Typ objektu promise sa určuje pomocou std::coroutine_traits, ktoré musia poskytovať príslušný promise_type pre návratový typ a typy parametrov coroutine (vrátane parametra objektu pri nestatickej členskej funkcii). Samotný návratový typ nemusí obsahovať vnorený promise_type. Samotný operátor nevytvára vlákno ani plánovač.

Ak sa pri explicitnom co_await nájde v type objektu promise deklarácia await_transform, awaitable je výsledok volania await_transform na tomto objekte s operandom ako argumentom. Inak je awaitable pôvodný operand. Ak sa pri výbere preťaženia pre awaitable vyberie operator co_await, výsledok volania sa použije ako awaiter. Iba ak je množina kandidátov pre operator co_await prázdna, použije sa ako awaiter samotný awaitable, po prípadnej transformácii. Ak množina nie je prázdna, ale neobsahuje žiadnu použiteľnú funkciu, výraz co_await je neplatný. Awaiter poskytuje await_ready(), await_suspend(h) a await_resume(). Výraz má typ a kategóriu hodnoty výsledku volania await_resume().

Výsledok await_ready() sa kontextovo konvertuje na bool. Ak konverzia dá hodnotu true, k pozastaveniu nedôjde. Platí to aj vtedy, keď je výsledkom objekt typu triedy, ktorého explicit operator bool() vracia true. Ak konverzia dá hodnotu false, coroutine sa pozastaví a zavolá sa await_suspend(h). Ak má await_suspend návratový typ void, samotný návrat z volania nespôsobí, že mechanizmus co_await coroutine obnoví. Funkcia await_suspend ju však môže obnoviť sama alebo zariadiť, aby ju obnovilo iné vlákno, a to aj pred návratom z volania. Výsledok typu bool s hodnotou false coroutine okamžite obnoví a vrátenie handle coroutine odovzdá vykonávanie uvedenej coroutine. await_resume() poskytne výsledok pri pokračovaní vykonávania.

Príklad používa std::suspend_always: run() vypíše start a odovzdá riadenie; resume() jej umožní vypísať resumed. final_suspend() ponechá frame pozastavený, aby ho mohol uvoľniť deštruktor Task. Coroutine nikdy neobnovujte v jej konečnom bode pozastavenia; objekty používané po obnovení musia stále existovať.

Tento záznam sa týka C++23; uvedený web publikuje priebežne sa vyvíjajúci návrh, nie nemenný text C++23. Kompatibilita s produkčným runtime prostredím nie je potvrdená.

Príklady

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

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_never initial_suspend() noexcept { return {}; }
        std::suspend_always final_suspend() noexcept { return {}; }
        void return_void() noexcept {}
        void unhandled_exception() noexcept { std::terminate(); }
    };

    Handle handle;
    explicit Task(Handle h) noexcept : handle(h) {}
    Task(const Task&) = delete;
    Task& operator=(const Task&) = delete;
    ~Task() { handle.destroy(); }
};

Task run() {
    std::cout << "start\n";
    co_await std::suspend_always{};
    std::cout << "resumed\n";
}

int main() {
    auto task = run();
    std::cout << "caller\n";
    task.handle.resume();
}

Výsledok

start
caller
resumed

Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.

Zdroje