• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4<title>system_executor::dispatch</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="../system_executor.html" title="system_executor">
9<link rel="prev" href="defer.html" title="system_executor::defer">
10<link rel="next" href="on_work_finished.html" title="system_executor::on_work_finished">
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="defer.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../system_executor.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="on_work_finished.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.system_executor.dispatch"></a><a class="link" href="dispatch.html" title="system_executor::dispatch">system_executor::dispatch</a>
28</h4></div></div></div>
29<p>
30          <a class="indexterm" name="boost_asio.indexterm.system_executor.dispatch"></a>
31Request
32          the system executor to invoke the given function object.
33        </p>
34<pre class="programlisting">template&lt;
35    typename Function,
36    typename Allocator&gt;
37void dispatch(
38    Function &amp;&amp; f,
39    const Allocator &amp; a) const;
40</pre>
41<p>
42          This function is used to ask the executor to execute the given function
43          object. The function object will always be executed inside this function.
44        </p>
45<h6>
46<a name="boost_asio.reference.system_executor.dispatch.h0"></a>
47          <span class="phrase"><a name="boost_asio.reference.system_executor.dispatch.parameters"></a></span><a class="link" href="dispatch.html#boost_asio.reference.system_executor.dispatch.parameters">Parameters</a>
48        </h6>
49<div class="variablelist">
50<p class="title"><b></b></p>
51<dl class="variablelist">
52<dt><span class="term">f</span></dt>
53<dd>
54<p>
55                The function object to be called. The executor will make a copy of
56                the handler object as required. The function signature of the function
57                object must be:
58</p>
59<pre class="programlisting">void function();
60</pre>
61<p>
62              </p>
63</dd>
64<dt><span class="term">a</span></dt>
65<dd><p>
66                An allocator that may be used by the executor to allocate the internal
67                storage needed for function invocation.
68              </p></dd>
69</dl>
70</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 &#169; 2003-2019 Christopher M. Kohlhoff<p>
75        Distributed under the Boost Software License, Version 1.0. (See accompanying
76        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>)
77      </p>
78</div></td>
79</tr></table>
80<hr>
81<div class="spirit-nav">
82<a accesskey="p" href="defer.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../system_executor.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="on_work_finished.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
83</div>
84</body>
85</html>
86