File: IteratorConnectToken.qbk

package info (click to toggle)
boost1.88 1.88.0-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 576,932 kB
  • sloc: cpp: 4,149,234; xml: 136,789; ansic: 35,092; python: 33,910; asm: 5,698; sh: 4,604; ada: 1,681; makefile: 1,633; pascal: 1,139; perl: 1,124; sql: 640; yacc: 478; ruby: 271; java: 77; lisp: 24; csh: 6
file content (113 lines) | stat: -rw-r--r-- 2,777 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
[/
 / 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)
 /]

[section:IteratorConnectToken Iterator connect token requirements]

An iterator connect token is a [link boost_asio.overview.model.completion_tokens
completion token] for completion signature `void(error_code, Iterator)`, where
the type `Iterator` is used in the corresponding `async_connect()` function.

[heading Examples]

A free function as an iterator connect token:

  void connect_handler(
      const boost::system::error_code& ec,
      boost::asio::ip::tcp::resolver::iterator iterator)
  {
    ...
  }

An iterator connect token function object:

  struct connect_handler
  {
    ...
    template <typename Iterator>
    void operator()(
        const boost::system::error_code& ec,
        Iterator iterator)
    {
      ...
    }
    ...
  };

A lambda as an iterator connect token:

  boost::asio::async_connect(...,
      [](const boost::system::error_code& ec,
        boost::asio::ip::tcp::resolver::iterator iterator)
      {
        ...
      });

A non-static class member function adapted to an iterator connect token using
`std::bind()`:

  void my_class::connect_handler(
      const boost::system::error_code& ec,
      boost::asio::ip::tcp::resolver::iterator iterator)
  {
    ...
  }
  ...
  boost::asio::async_connect(...,
      std::bind(&my_class::connect_handler,
        this, std::placeholders::_1,
        std::placeholders::_2));

A non-static class member function adapted to an iterator connect token using
`boost::bind()`:

  void my_class::connect_handler(
      const boost::system::error_code& ec,
      boost::asio::ip::tcp::resolver::iterator iterator)
  {
    ...
  }
  ...
  boost::asio::async_connect(...,
      boost::bind(&my_class::connect_handler,
        this, boost::asio::placeholders::error,
        boost::asio::placeholders::iterator));

Using [link boost_asio.reference.use_future use_future] as an iterator connect token:

  std::future<boost::asio::ip::tcp::resolver::iterator> f =
    boost::asio::async_connect(..., boost::asio::use_future);
  ...
  try
  {
    boost::asio::ip::tcp::resolver::iterator i = f.get();
    ...
  }
  catch (const system_error& e)
  {
    ...
  }

Using [link boost_asio.reference.use_awaitable use_awaitable] as an iterator connect
token:

  boost::asio::awaitable<void> my_coroutine()
  {
    try
    {
      ...
      boost::asio::ip::tcp::resolver::iterator i =
        co_await boost::asio::async_connect(
            ..., boost::asio::use_awaitable);
      ...
    }
    catch (const system_error& e)
    {
      ...
    }
  }

[endsect]