• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>dispatch (1 of 3 overloads)</title>
5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../dispatch.html" title="dispatch">
9<link rel="prev" href="../dispatch.html" title="dispatch">
10<link rel="next" href="overload2.html" title="dispatch (2 of 3 overloads)">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="../dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../dispatch.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="boost_asio.reference.dispatch.overload1"></a><a class="link" href="overload1.html" title="dispatch (1 of 3 overloads)">dispatch (1
28        of 3 overloads)</a>
29</h4></div></div></div>
30<p>
31          Submits a completion token or function object for execution.
32        </p>
33<pre class="programlisting">template&lt;
34    typename CompletionToken&gt;
35<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> dispatch(
36    CompletionToken &amp;&amp; token);
37</pre>
38<p>
39          This function submits an object for execution using the object's associated
40          executor. The function object may be called from the current thread prior
41          to returning from <code class="computeroutput">dispatch()</code>. Otherwise, it is queued for
42          execution.
43        </p>
44<p>
45          This function has the following effects:
46        </p>
47<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
48<li class="listitem">
49              Constructs a function object handler of type <code class="computeroutput">Handler</code>,
50              initialized with <code class="computeroutput">handler(forward&lt;CompletionToken&gt;(token))</code>.
51            </li>
52<li class="listitem">
53              Constructs an object <code class="computeroutput">result</code> of type <code class="computeroutput">async_result&lt;Handler&gt;</code>,
54              initializing the object as <code class="computeroutput">result(handler)</code>.
55            </li>
56<li class="listitem">
57              Obtains the handler's associated executor object <code class="computeroutput">ex</code> by
58              performing <code class="computeroutput">get_associated_executor(handler)</code>.
59            </li>
60<li class="listitem">
61              Obtains the handler's associated allocator object <code class="computeroutput">alloc</code>
62              by performing <code class="computeroutput">get_associated_allocator(handler)</code>.
63            </li>
64<li class="listitem">
65              Performs <code class="computeroutput">ex.dispatch(std::move(handler), alloc)</code>.
66            </li>
67<li class="listitem">
68              Returns <code class="computeroutput">result.get()</code>.
69            </li>
70</ul></div>
71</div>
72<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
73<td align="left"></td>
74<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
75      Kohlhoff<p>
76        Distributed under the Boost Software License, Version 1.0. (See accompanying
77        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
78      </p>
79</div></td>
80</tr></table>
81<hr>
82<div class="spirit-nav">
83<a accesskey="p" href="../dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../dispatch.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
84</div>
85</body>
86</html>
87