Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / C++

co_await — oczekiwanie w korutynie

Wyrażenie co_await korzysta z protokołu awaitera, aby opcjonalnie zawiesić korutynę i następnie uzyskać wynik. Samo nie uruchamia wątku ani nie zapewnia mechanizmu planowania; wznowienie musi wynikać z użytej implementacji.

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

Składnia

co_await cast-expression

co_await expression oznacza punkt możliwego zawieszenia korutyny, a nie blokujące oczekiwanie wątku. Umieszczenie takiego wyrażenia w ciele funkcji czyni ją korutyną. Typ obiektu promise określa std::coroutine_traits: musi on udostępniać odpowiedni promise_type dla typu zwracanego i typów parametrów korutyny (w tym parametru obiektu dla niestatycznej funkcji składowej). Sam typ zwracany nie musi mieć zagnieżdżonego promise_type. Sam operator nie tworzy wątku ani planisty.

Dla jawnego co_await, jeśli wyszukiwanie nazwy await_transform w typie obiektu promise znajdzie deklarację, wyrażeniem awaitable jest wynik wywołania await_transform na tym obiekcie z operandem jako argumentem. W przeciwnym razie wyrażeniem awaitable jest pierwotny operand. Jeśli rozstrzyganie przeciążeń wybierze operator co_await dla wyrażenia awaitable, wynik wywołania operatora służy jako awaiter. Tylko gdy zbiór kandydatów na operator co_await jest pusty, jako awaiter służy samo wyrażenie awaitable — po przekształceniu, jeśli je zastosowano. Jeśli zbiór kandydatów nie jest pusty, ale żadna z tych funkcji nie spełnia warunków stosowalności, wyrażenie co_await jest niepoprawne. Awaiter udostępnia await_ready(), await_suspend(h) i await_resume(). Wynik wyrażenia ma typ i kategorię wartości wyniku await_resume().

Wynik await_ready() podlega konwersji kontekstowej do bool. Jeśli konwersja daje true, korutyna nie jest zawieszana; dotyczy to również wyniku będącego obiektem typu klasowego, którego explicit operator bool() zwraca true. Jeśli konwersja daje false, korutyna jest zawieszana i wywoływane jest await_suspend(h). Jeśli await_suspend ma typ zwracany void, sam powrót z wywołania nie powoduje wznowienia przez mechanizm co_await. Funkcja await_suspend może jednak sama wznowić korutynę lub zorganizować jej wznowienie przez inny wątek, nawet przed zakończeniem wywołania. Wynik typu bool o wartości false powoduje natychmiastowe wznowienie, a zwrócenie uchwytu korutyny przekazuje wykonanie do wskazanej korutyny. await_resume() dostarcza wynik przy kontynuowaniu wykonania.

Przykład używa std::suspend_always: run() wypisuje start, oddaje sterowanie, a resume() pozwala wypisać resumed. final_suspend() pozostawia ramkę zawieszoną do zwolnienia przez destruktor Task. Nie wolno wznawiać korutyny w końcowym punkcie zawieszenia; obiekty używane po wznowieniu muszą nadal istnieć.

Zakres wpisu to C++23; podany serwis publikuje rozwijany szkic, nie zamrożony tekst C++23. Nie poświadczono zgodności środowiska produkcyjnego.

Przykłady

#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();
}

Wynik

start
caller
resumed

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła