File: co_spawn.cpp

package info (click to toggle)
boost1.90 1.90.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 593,120 kB
  • sloc: cpp: 4,190,908; xml: 196,648; python: 34,618; ansic: 23,145; asm: 5,468; sh: 3,774; makefile: 1,161; perl: 1,020; sql: 728; ruby: 676; yacc: 478; java: 77; lisp: 24; csh: 6
file content (188 lines) | stat: -rw-r--r-- 4,222 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
//
// co_spawn.cpp
// ~~~~~~~~~~~~
//
// Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//

// Disable autolinking for unit tests.
#if !defined(BOOST_ALL_NO_LIB)
#define BOOST_ALL_NO_LIB 1
#endif // !defined(BOOST_ALL_NO_LIB)

// Test that header file is self-contained.
#include <boost/asio/co_spawn.hpp>

#include "unit_test.hpp"

#if defined(BOOST_ASIO_HAS_CO_AWAIT)

#include <stdexcept>
#include <boost/asio/any_completion_handler.hpp>
#include <boost/asio/bind_cancellation_slot.hpp>
#include <boost/asio/dispatch.hpp>
#include <boost/asio/io_context.hpp>
#include <boost/asio/use_awaitable.hpp>

boost::asio::awaitable<void> void_returning_coroutine()
{
  co_return;
}

boost::asio::awaitable<int> int_returning_coroutine()
{
  co_return 42;
}

void test_co_spawn_with_any_completion_handler()
{
  boost::asio::io_context ctx;

  bool called = false;
  boost::asio::co_spawn(ctx, void_returning_coroutine(),
      boost::asio::any_completion_handler<void(std::exception_ptr)>(
        [&](std::exception_ptr)
        {
          called = true;
        }));

  BOOST_ASIO_CHECK(!called);

  ctx.run();

  BOOST_ASIO_CHECK(called);

  int result = 0;
  boost::asio::co_spawn(ctx, int_returning_coroutine(),
      boost::asio::any_completion_handler<void(std::exception_ptr, int)>(
        [&](std::exception_ptr, int i)
        {
          result = i;
        }));

  BOOST_ASIO_CHECK(result == 0);

  ctx.restart();
  ctx.run();

  BOOST_ASIO_CHECK(result == 42);
}

void test_co_spawn_immediate_cancel()
{
  boost::asio::cancellation_signal sig;
  boost::asio::io_context ctx;

  std::exception_ptr result = nullptr;
  bool called = false;
  boost::asio::co_spawn(ctx, void_returning_coroutine(),
      boost::asio::bind_cancellation_slot(sig.slot(),
        [&](std::exception_ptr e)
        {
          result = e;
          called = true;
        }));

  BOOST_ASIO_CHECK(!called);
  BOOST_ASIO_CHECK(result == nullptr);

  sig.emit(boost::asio::cancellation_type::all);
  ctx.run();

  BOOST_ASIO_CHECK(called);
  BOOST_ASIO_CHECK(result != nullptr);

  result = nullptr;
  called = false;
  boost::asio::co_spawn(ctx, int_returning_coroutine(),
      boost::asio::bind_cancellation_slot(sig.slot(),
        [&](std::exception_ptr e, int i)
        {
          BOOST_ASIO_CHECK(i != 42);
          result = e;
          called = true;
        }));

  BOOST_ASIO_CHECK(!called);
  BOOST_ASIO_CHECK(result == nullptr);

  sig.emit(boost::asio::cancellation_type::all);
  ctx.restart();
  ctx.run();

  BOOST_ASIO_CHECK(called);
  BOOST_ASIO_CHECK(result != nullptr);
}

boost::asio::awaitable<void> void_returning_dispatch_coroutine()
{
  co_await boost::asio::dispatch(boost::asio::use_awaitable);
  co_return;
}

boost::asio::awaitable<int> int_returning_dispatch_coroutine()
{
  co_await boost::asio::dispatch(boost::asio::use_awaitable);
  co_return 42;
}

void test_co_spawn_with_immediate_completion_via_dispatch()
{
  boost::asio::io_context ctx;

  bool called = false;
  boost::asio::post(ctx,
      [&]
      {
        boost::asio::co_spawn(ctx, void_returning_dispatch_coroutine(),
            [&](std::exception_ptr)
            {
              called = true;
            });

        BOOST_ASIO_CHECK(!called);
      });

  ctx.run();

  BOOST_ASIO_CHECK(called);

  int result = 0;
  boost::asio::post(ctx,
      [&]
      {
        boost::asio::co_spawn(ctx, int_returning_dispatch_coroutine(),
            [&](std::exception_ptr, int i)
            {
              result = i;
            });

        BOOST_ASIO_CHECK(result == 0);
      });

  ctx.restart();
  ctx.run();

  BOOST_ASIO_CHECK(result == 42);
}

BOOST_ASIO_TEST_SUITE
(
  "co_spawn",
  BOOST_ASIO_TEST_CASE(test_co_spawn_with_any_completion_handler)
  BOOST_ASIO_TEST_CASE(test_co_spawn_immediate_cancel)
  BOOST_ASIO_TEST_CASE(test_co_spawn_with_immediate_completion_via_dispatch)
)

#else // defined(BOOST_ASIO_HAS_CO_AWAIT)

BOOST_ASIO_TEST_SUITE
(
  "co_spawn",
  BOOST_ASIO_TEST_CASE(null_test)
)

#endif // defined(BOOST_ASIO_HAS_CO_AWAIT)