{"id":109727,"date":"2024-05-06T07:00:00","date_gmt":"2024-05-06T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=109727"},"modified":"2024-05-06T06:49:34","modified_gmt":"2024-05-06T13:49:34","slug":"20240506-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20240506-00\/?p=109727","title":{"rendered":"Awaiting a set of handles with a timeout, part 5: Generalizing the awaiter"},"content":{"rendered":"

Last time, we created an awaiter that could await an array of handles<\/a>. But it’s often the case that you have a bunch of handles in some other form, such as a pair of iterators, which is a common currency in the C++ standard library.<\/p>\n

First, let’s generalize our version to take a pair of iterators.<\/p>\n

struct resume_all_awaiter\r\n{\r\n    \u27e6 data members unchanged \u27e7\r\n\r\n    template<typename Iter><\/span>\r\n    awaiter(Iter first, Iter last<\/span>,\r\n        std::optional<TimeSpan> timeout) :\r\n        \/\/ m_remaining(size),<\/span><\/span>\r\n        \/\/ m_states(size),<\/span>   <\/span>\r\n        \/\/ m_results(size),<\/span>  <\/span>\r\n        m_timeout(timeout)\r\n    {\r\n        std::transform(first, last, std::back_inserter(m_states),<\/span>\r\n            [](HANDLE h) { state s; s.m_handle = h; return s; });<\/span>\r\n        create_waits();                                          <\/span>\r\n    }\r\n\r\n    void create_waits()                                          <\/span>\r\n    {                                                            <\/span>\r\n        if (m_states.size() > ~0U \/ sizeof(bool)) {              <\/span>\r\n            throw std::bad_alloc();                              <\/span>\r\n        }                                                        <\/span>\r\n    \u00a0                                                            <\/span>\r\n        auto size = static_cast<uint32_t>(m_states.size());      <\/span>\r\n        m_remaining.store(size, std::memory_order_relaxed);      <\/span>\r\n        auto results = winrt::com_array{ size };                 <\/span>\r\n        for (auto index = 0U; index < size; ++index) {           <\/span>\r\n            auto& s = m_states[index];                           <\/span>\r\n            s.m_parent = this;                                   <\/span>\r\n            s.m_result = &m_results[index];                      <\/span>\r\n            s.m_wait.reset(winrt::check_pointer(                 <\/span>\r\n                CreateThreadpoolWait(callback, &s, nullptr)));   <\/span>\r\n        }                                                        <\/span>\r\n    }                                                            <\/span>\r\n\r\n    \u27e6 other methods unchanged \u27e7\r\n};\r\n\r\ntemplate<typename Iter><\/span>\r\nauto resume_on_all_signaled(Iter first, Iter last,<\/span>\r\n    std::optional<winrt::Windows::Foundation::TimeSpan> timeout\r\n        = std::nullopt)\r\n{\r\n    return resume_all_awaiter(first, last<\/span>, timeout);\r\n}\r\n<\/pre>\n
First, we record all of the handles that we were given, in the same number of resume_all_state<\/code> objects. We can’t call Create\u00adThreadpool\u00adWait<\/code> yet, because we want to use a pointer to the resume_all_state<\/code> as the context pointer, which means we have to wait until all of the elements have been pushed onto the vector before we start taking their addresses. Otherwise, they will move when the vector expands its capacity.<\/p>\n
We build up the vector by pushing handles one at a time. We can’t preallocate the vector because the iterator may support only forward iteration, so the only way to find out how many handles there are is to increment the iterator all the way to the end. And it may be only an input iterator, which means you can walk through the collection only once.<\/p>\n
That value becomes m_remaining<\/code>, the number of handles we are still waiting for. We also use that value to size the C-style array of bool<\/code>s that will be used to hold the results.<\/p>\n
After vector has been filled with handles, we can initialize the rest of the state and create the wait objects, confident that the resume_all_state<\/code> objects won’t move any more.<\/p>\n
To reduce code size, the second half of the calculations are factored into a helper method, which can be shared among different specializations of the constructor.<\/p>\n
We can add a helper method to simplify the case where the handles are already being held in an iterable container:<\/p>\n
template<typename Container = std::initializer_list<HANDLE>>\r\nauto resume_on_all_signaled(Container const& c,\r\n    std::optional<winrt::Windows::Foundation::TimeSpan> timeout\r\n        = std::nullopt)\r\n{\r\n    return resume_on_all_signaled(\r\n        std::begin(c), std::end(c), timeout);\r\n}\r\n<\/pre>\n
Since we are binding to a const&<\/code>, the container parameter might be a temporary. This was the important case I mentioned last time.<\/p>\n
We give a default type of std::initializer_list<HANDLE><\/code> so that you can write this:<\/p>\n
co_await resume_on_all_signaled({ handle1, handle2 });\r\n<\/pre>\n
Next time, we’ll make this code more efficient in the case that the iterators are random-access, or at least random-access-like.<\/p>\n","protected":false},"excerpt":{"rendered":"
Fitting into existing patterns.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-109727","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Fitting into existing patterns.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109727","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=109727"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109727\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=109727"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=109727"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=109727"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}