blob: 563c39f1704c05da16c008a732eab421db06f09d (
plain)
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>io_context::dispatch</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="../io_context.html" title="io_context">
<link rel="prev" href="destroy.html" title="io_context::destroy">
<link rel="next" href="fork_event.html" title="io_context::fork_event">
</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="destroy.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.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="fork_event.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.io_context.dispatch"></a><a class="link" href="dispatch.html" title="io_context::dispatch">io_context::dispatch</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="boost_asio.indexterm.io_context.dispatch"></a>
(Deprecated:
Use <a class="link" href="../dispatch.html" title="dispatch"><code class="computeroutput">dispatch</code></a>.)
Request the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
to invoke the given handler.
</p>
<pre class="programlisting">template<
typename <a class="link" href="../CompletionHandler.html" title="Completion handler requirements">CompletionHandler</a>>
<a class="link" href="../asynchronous_operations/automatic_deduction_of_initiating_function_return_type.html" title="Automatic deduction of initiating function return type"><span class="emphasis"><em>DEDUCED</em></span></a> dispatch(
CompletionHandler && handler);
</pre>
<p>
This function is used to ask the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
to execute the given handler.
</p>
<p>
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
<code class="computeroutput">run()</code>, <code class="computeroutput">run_one()</code>, <code class="computeroutput">poll()</code> or <code class="computeroutput">poll_one()</code>
member functions is currently being invoked. The handler may be executed
inside this function if the guarantee can be met.
</p>
<h6>
<a name="boost_asio.reference.io_context.dispatch.h0"></a>
<span class="phrase"><a name="boost_asio.reference.io_context.dispatch.parameters"></a></span><a class="link" href="dispatch.html#boost_asio.reference.io_context.dispatch.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 <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
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>
<h6>
<a name="boost_asio.reference.io_context.dispatch.h1"></a>
<span class="phrase"><a name="boost_asio.reference.io_context.dispatch.remarks"></a></span><a class="link" href="dispatch.html#boost_asio.reference.io_context.dispatch.remarks">Remarks</a>
</h6>
<p>
This function throws an exception only if:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
the handler's <code class="computeroutput">asio_handler_allocate</code> function; or
</li>
<li class="listitem">
the handler's copy constructor
</li>
</ul></div>
<p>
throws an exception.
</p>
</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-2017 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="destroy.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.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="fork_event.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
