1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>strand::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="../strand.html" title="strand"> 9<link rel="prev" href="defer.html" title="strand::defer"> 10<link rel="next" href="execute.html" title="strand::execute"> 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="../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="execute.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.strand.dispatch"></a><a class="link" href="dispatch.html" title="strand::dispatch">strand::dispatch</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="boost_asio.indexterm.strand.dispatch"></a> 31Request the strand to 32 invoke the given function object. 33 </p> 34<pre class="programlisting">template< 35 typename Function, 36 typename Allocator> 37void dispatch( 38 Function && f, 39 const Allocator & a) const; 40</pre> 41<p> 42 This function is used to ask the strand to execute the given function object 43 on its underlying executor. The function object will be executed inside 44 this function if the strand is not otherwise busy and if the underlying 45 executor's <code class="computeroutput">dispatch()</code> function is also able to execute the 46 function before returning. 47 </p> 48<h6> 49<a name="boost_asio.reference.strand.dispatch.h0"></a> 50 <span class="phrase"><a name="boost_asio.reference.strand.dispatch.parameters"></a></span><a class="link" href="dispatch.html#boost_asio.reference.strand.dispatch.parameters">Parameters</a> 51 </h6> 52<div class="variablelist"> 53<p class="title"><b></b></p> 54<dl class="variablelist"> 55<dt><span class="term">f</span></dt> 56<dd> 57<p> 58 The function object to be called. The executor will make a copy of 59 the handler object as required. The function signature of the function 60 object must be: 61</p> 62<pre class="programlisting">void function(); 63</pre> 64<p> 65 </p> 66</dd> 67<dt><span class="term">a</span></dt> 68<dd><p> 69 An allocator that may be used by the executor to allocate the internal 70 storage needed for function invocation. 71 </p></dd> 72</dl> 73</div> 74</div> 75<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 76<td align="left"></td> 77<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M. 78 Kohlhoff<p> 79 Distributed under the Boost Software License, Version 1.0. (See accompanying 80 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>) 81 </p> 82</div></td> 83</tr></table> 84<hr> 85<div class="spirit-nav"> 86<a accesskey="p" href="defer.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="execute.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> 87</div> 88</body> 89</html> 90
