快捷導(dǎo)航

從使用角度解讀c++20 協(xié)程示例

更新時間：2023年01月05日 10:12:48 作者：ww_250

類比線程，線程是個函數(shù)，把這個函數(shù)交給創(chuàng)建線程的api，然后這個函數(shù)就變成線程了，這個函數(shù)本身沒有任何特殊的地方，就是普通函數(shù)，這篇文章主要介紹了從使用角度解讀c++20 協(xié)程示例,需要的朋友可以參考下

協(xié)程長什么樣子

網(wǎng)上一堆亂七八糟的定義，看的人云里霧里，毫無意義。下面從實戰(zhàn)角度看看協(xié)程到底長什么樣子。

首先，類比線程，線程是個函數(shù)。把這個函數(shù)交給創(chuàng)建線程的api，然后這個函數(shù)就變成線程了。這個函數(shù)本身沒有任何特殊的地方，就是普通函數(shù)。

相比于線程，協(xié)程也是個函數(shù)，不過協(xié)程函數(shù)比線程函數(shù)講究多了。
它必須要有返回值，返回值的類型還必須’內(nèi)嵌’一個promise_type類型promise_type類型還必須至少包含幾個特定的實現(xiàn)

返回值類型最簡如下：

struct task {
  struct promise_type {
    std::suspend_never initial_suspend() noexcept { return {}; }
    std::suspend_never final_suspend() noexcept { return {}; }
    void unhandled_exception() noexcept {}
    task get_return_object() noexcept { return {}; }
  };
};

從表現(xiàn)形式上說，下面就是個最簡協(xié)程函數(shù)：

task do_by_coroutine() {}

c++20的協(xié)程三板斧

co_await、co_return、co_yield。

這3個關(guān)鍵字是用來控制協(xié)程運行的，那么自然只能在協(xié)程函數(shù)里面使用。他們到底是用來干什么的？

co_return

最簡單最好理解的。普通函數(shù)返回用return，協(xié)程函數(shù)返回用co_return，沒什么稀奇的含義，很好理解。但是用起來又比較講究。

如果協(xié)程函數(shù)返回’void’，那么promise_type類型需要對應(yīng)加一個return_void實現(xiàn)

struct task {
  struct promise_type {
    ...
    void return_void() noexcept {} //for co_return void
  };
};

如果協(xié)程函數(shù)返回’值’，那么promise_type類型需要對應(yīng)加一個return_value實現(xiàn)，比如返回一個字符串，形參v就是返回的’值’

struct task {
  struct promise_type {
    ...
    void return_value(std::string&& v) noexcept {} //for co_return value
  };
};

co_yield

co_yield其實沒必要去深入理解它，它其實是co_await的一個’變體糖’。co_yield expr 會被轉(zhuǎn)化為 co_await promise.yield_value(expr)，本質(zhì)還是co_await。

同樣co_yield用起來也比較講究。掛起協(xié)程同時返回一個值，promise_type類型需要對應(yīng)加一個yield_value實現(xiàn)，比如返回一個字符串，形參from就是返回的’值’

struct task {
  struct promise_type {
    ...
    std::suspend_always yield_value(std::string&& from) noexcept{ //for co_yield value
      value_ = std::move(from);
      return {};
    }
    std::string value_;
  };
};

co_await

最后一個同時也是最講究的關(guān)鍵字。

co_await expr，從這個expr必須可以得到awaitable對象。到底什么是awaitable？包含以下3個特定實現(xiàn)的就是awaitable，最簡的awaitable定義如下：

struct awaitable {
  bool await_ready() noexcept { return false; }
  std::string await_resume() noexcept { return "123"; };
  void await_suspend(std::coroutine_handle<> h) noexcept {};
};

最簡單的使用方式：

auto value = co_await awaiter{};

上述語句怎么和awaitable的3個實現(xiàn)關(guān)聯(lián)起來的？

首先調(diào)用await_ready，根據(jù)返回值來控制協(xié)程運行。
如果返回值false，則會調(diào)用await_suspend，掛起協(xié)程，形參h表示協(xié)程對象，可以用來控制協(xié)程。
如果返回值true，則會調(diào)用await_resume，返回"123"給value，不過await_ready通常為false，因為需要主動控制協(xié)程。
第2步中，掛起協(xié)程后，可以調(diào)用resume在合適的時機恢復(fù)協(xié)程運行，調(diào)用resume后，await_resume會被調(diào)用，返回"123"給value。
主要是步驟1->2->4，await_resume返回值也可以為空。