• 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 (2 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="overload1.html" title="dispatch (1 of 3 overloads)">
10<link rel="next" href="overload3.html" title="dispatch (3 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="overload1.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="overload3.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.overload2"></a><a class="link" href="overload2.html" title="dispatch (2 of 3 overloads)">dispatch (2
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 <a class="link" href="../Executor1.html" title="Executor requirements">Executor</a>,
35    typename CompletionToken = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
36<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(
37    const Executor &amp; ex,
38    CompletionToken &amp;&amp; token = <a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>,
39    typename enable_if&lt; execution::is_executor&lt; Executor &gt;::value||is_executor&lt; Executor &gt;::value &gt;::type *  = 0);
40</pre>
41<p>
42          This function submits an object for execution using the specified executor.
43          The function object may be called from the current thread prior to returning
44          from <code class="computeroutput">dispatch()</code>. Otherwise, it is queued for execution.
45        </p>
46<p>
47          This function has the following effects:
48        </p>
49<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
50<li class="listitem">
51              Constructs a function object handler of type <code class="computeroutput">Handler</code>,
52              initialized with <code class="computeroutput">handler(forward&lt;CompletionToken&gt;(token))</code>.
53            </li>
54<li class="listitem">
55              Constructs an object <code class="computeroutput">result</code> of type <code class="computeroutput">async_result&lt;Handler&gt;</code>,
56              initializing the object as <code class="computeroutput">result(handler)</code>.
57            </li>
58<li class="listitem">
59              Obtains the handler's associated executor object <code class="computeroutput">ex1</code> by
60              performing <code class="computeroutput">get_associated_executor(handler)</code>.
61            </li>
62<li class="listitem">
63              Creates a work object <code class="computeroutput">w</code> by performing <code class="computeroutput">make_work(ex1)</code>.
64            </li>
65<li class="listitem">
66              Obtains the handler's associated allocator object <code class="computeroutput">alloc</code>
67              by performing <code class="computeroutput">get_associated_allocator(handler)</code>.
68            </li>
69<li class="listitem">
70              Constructs a function object <code class="computeroutput">f</code> with a function call operator
71              that performs <code class="computeroutput">ex1.dispatch(std::move(handler), alloc)</code>
72              followed by <code class="computeroutput">w.reset()</code>.
73            </li>
74<li class="listitem">
75              Performs <code class="computeroutput">Executor(ex).dispatch(std::move(f), alloc)</code>.
76            </li>
77<li class="listitem">
78              Returns <code class="computeroutput">result.get()</code>.
79            </li>
80</ul></div>
81</div>
82<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
83<td align="left"></td>
84<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
85      Kohlhoff<p>
86        Distributed under the Boost Software License, Version 1.0. (See accompanying
87        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>)
88      </p>
89</div></td>
90</tr></table>
91<hr>
92<div class="spirit-nav">
93<a accesskey="p" href="overload1.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="overload3.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
94</div>
95</body>
96</html>
97