doc/html/boost_asio/reference/io_context__strand/dispatch/overload2.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>io_context::strand::dispatch (2 of 2 overloads)</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="../dispatch.html" title="io_context::strand::dispatch">
<link rel="prev" href="overload1.html" title="io_context::strand::dispatch (1 of 2 overloads)">
<link rel="next" href="../get_io_context.html" title="io_context::strand::get_io_context">
</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="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="../get_io_context.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="boost_asio.reference.io_context__strand.dispatch.overload2"></a><a class="link" href="overload2.html" title="io_context::strand::dispatch (2 of 2 overloads)">io_context::strand::dispatch
          (2 of 2 overloads)</a>
</h5></div></div></div>
<p>
            (Deprecated: Use <a class="link" href="../../dispatch.html" title="dispatch"><code class="computeroutput">dispatch</code></a>.)
            Request the strand to invoke the given handler.
          </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../../LegacyCompletionHandler.html" title="Legacy completion handler requirements">LegacyCompletionHandler</a>&gt;
<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(
    LegacyCompletionHandler &amp;&amp; handler);
</pre>
<p>
            This function is used to ask the strand to execute the given handler.
          </p>
<p>
            The strand object guarantees that handlers posted or dispatched through
            the strand will not be executed concurrently. The handler may be executed
            inside this function if the guarantee can be met. If this function is
            called from within a handler that was posted or dispatched through the
            same strand, then the new handler will be executed immediately.
          </p>
<p>
            The strand's guarantee is in addition to the guarantee provided by the
            underlying <a class="link" href="../../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>.
            The <a class="link" href="../../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
            guarantees that the handler will only be called in a thread in which
            the io_context's run member function is currently being invoked.
          </p>
<h6>
<a name="boost_asio.reference.io_context__strand.dispatch.overload2.h0"></a>
            <span class="phrase"><a name="boost_asio.reference.io_context__strand.dispatch.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.io_context__strand.dispatch.overload2.parameters">Parameters</a>
          </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl class="variablelist">
<dt><span class="term">handler</span></dt>
<dd>
<p>
                  The handler to be called. The strand will make a copy of the handler
                  object as required. The function signature of the handler must
                  be:
</p>
<pre class="programlisting">void handler();
</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 &#169; 2003-2018 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="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="../get_io_context.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>