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

CKTIS / C++

co_await — изчакване в корутина

Изразът co_await използва протокола на awaiter, за да спре корутина по избор и след това да получи резултат. Сам по себе си той не стартира нишка и не осигурява планиране; използваната имплементация трябва да се погрижи за възобновяването.

Версия: C++23; repository compiler flag, production runtime not attested

Синтаксис

co_await cast-expression

co_await expression обозначава възможна точка на спиране на корутина, а не блокиращо изчакване на нишка. Добавянето на такъв израз в тялото на функция я превръща в корутина. Типът на обекта promise се определя чрез std::coroutine_traits, който трябва да предостави подходящ promise_type за връщания тип и типовете на параметрите на корутината (включително параметъра за обекта при нестатична член-функция). Самият връщан тип не е длъжен да съдържа вложен promise_type. Самият оператор не създава нито нишка, нито планировчик.

При изричен co_await, ако търсенето на await_transform в типа на обекта promise открие декларация, awaitable е резултатът от извикването на await_transform върху този обект с операнда като аргумент. В противен случай awaitable е първоначалният операнд. Ако при избора на претоварване за awaitable бъде избран operator co_await, резултатът от извикването се използва като awaiter. Самият awaitable се използва като awaiter, след евентуалното преобразуване, само ако множеството от кандидати за operator co_await е празно. Ако множеството не е празно, но не съдържа нито една приложима функция, изразът co_await е некоректно формиран. Awaiter предоставя await_ready(), await_suspend(h) и await_resume(). Изразът има типа и категорията на стойността на резултата от await_resume().

Резултатът от await_ready() се преобразува контекстно към bool. Ако преобразуването даде true, корутината не се спира. Това важи и когато резултатът е обект от класов тип, чийто explicit operator bool() връща true. Ако преобразуването даде false, корутината се спира и се извиква await_suspend(h). Ако типът на връщане на await_suspend е void, самото връщане от извикването не кара механизма на co_await да възобнови корутината. Въпреки това await_suspend може сам да я възобнови или да осигури възобновяването ѝ от друга нишка, дори преди извикването да приключи. Резултат от тип bool със стойност false възобновява корутината незабавно, а връщането на handle на корутина прехвърля изпълнението към посочената корутина. await_resume() предоставя резултата, когато изпълнението продължи.

Примерът използва std::suspend_always: run() извежда start и връща управлението; resume() ѝ позволява да изведе resumed. final_suspend() оставя frame-а спрян, за да може деструкторът на Task да го освободи. Никога не възобновявайте корутина в крайната ѝ точка на спиране; обектите, използвани след възобновяването, трябва все още да съществуват.

Този запис е за C++23; посоченият сайт публикува развиващ се проект, а не фиксиран текст на C++23. Съвместимостта с производствената среда за изпълнение не е удостоверена.

Примери

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

Резултат

start
caller
resumed

Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.

Източници