2021-10-05 21:37:46 +02:00

91 lines
4.5 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>strand::execute</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../strand.html" title="strand">
<link rel="prev" href="dispatch.html" title="strand::dispatch">
<link rel="next" href="get_inner_executor.html" title="strand::get_inner_executor">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
<td align="center"><a href="../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strand.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="get_inner_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.strand.execute"></a><a class="link" href="execute.html" title="strand::execute">strand::execute</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.strand.execute"></a>
Request the strand to invoke
the given function object.
</p>
<pre class="programlisting">template&lt;
typename Function&gt;
constraint&lt; execution::can_execute&lt; const Executor &amp;, Function &gt;::value, void &gt;::type execute(
Function &amp;&amp; f) const;
</pre>
<p>
Do not call this function directly. It is intended for use with the <a class="link" href="../execution__execute.html" title="execution::execute"><code class="computeroutput">execution::execute</code></a>
customisation point.
</p>
<p>
For example:
</p>
<pre class="programlisting">boost::asio::strand&lt;my_executor_type&gt; ex = ...;
execution::execute(ex, my_function_object);
</pre>
<p>
This function is used to ask the strand to execute the given function object
on its underlying executor. The function object will be executed according
to the properties of the underlying executor.
</p>
<h6>
<a name="boost_asio.reference.strand.execute.h0"></a>
<span class="phrase"><a name="boost_asio.reference.strand.execute.parameters"></a></span><a class="link" href="execute.html#boost_asio.reference.strand.execute.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">f</span></dt>
<dd>
<p>
The function object to be called. The executor will make a copy of
the handler object as required. The function signature of the function
object must be:
</p>
<pre class="programlisting">void function();
</pre>
<p>
</p>
</dd>
</dl>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2021 Christopher
M. Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="dispatch.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../strand.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="get_inner_executor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>